InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Types | Public Member Functions | List of all members
IHTMLPageItemSuite Class Referenceabstract

#include <IHTMLPageItemSuite.h>

Inheritance diagram for IHTMLPageItemSuite:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IHTMLPAGEITEMSUITE }
 

Public Member Functions

virtual bool32 IsHTMLSelection () const =0
 
virtual bool32 CanEditHTML () const =0
 
virtual WideString GetHTML () const =0
 
virtual ErrorCode SetHTML (const WideString &html) const =0
 
virtual void Refresh () const =0
 
virtual bool32 CanInsertHTMLPageItem () const =0
 
virtual ErrorCode InsertHTMLPageItem (bool32 openEditDialog) const =0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknown * QueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

Selection suite for manipulating HTML page items.

Member Function Documentation

virtual bool32 IHTMLPageItemSuite::CanEditHTML () const
pure virtual

Users cannot edit placed HTML. This routine let's the client know if the HTML is editable.

Returns
Whether or not the HTML can be edited.
virtual bool32 IHTMLPageItemSuite::CanInsertHTMLPageItem () const
pure virtual

Can we insert an HTML page item onto the layout and optionally open the "Edit HTML..." dialog for the page item?

Returns
kTrue if we can insert the default HTML page item into the layout.
virtual WideString IHTMLPageItemSuite::GetHTML () const
pure virtual

Get the HTML assigned to the currently selected HTML page item.

Returns
The HTML contained in the page item.
virtual ErrorCode IHTMLPageItemSuite::InsertHTMLPageItem (bool32 openEditDialog) const
pure virtual

Insert a default HTML page item and optionally open the "Edit HTML..." dialog for that page item.

Parameters
openEditDialog[IN]: pass kTrue to open the "Edit HTML..." dialog after creating the page item.
Returns
An error code indicating kSuccess or some failure.
virtual bool32 IHTMLPageItemSuite::IsHTMLSelection () const
pure virtual

Tests the current selection for HTML page items.

Returns
true if the selection is a single HTML page item or its container; false otherwise.
virtual void IHTMLPageItemSuite::Refresh () const
pure virtual

Force the poster image and the page item's geometry to update based on the current HTML.

virtual ErrorCode IHTMLPageItemSuite::SetHTML (const WideString & html) const
pure virtual

Set the provided HTML code into the currently selected HTML page item.

Parameters
html[IN] the new HTML code to set.
Returns
kSuccess if the HTML was successfully assigned to the page item; kFailure or some other errorcode otherwise. Note that some HTML page items cannot have their HTML edited. Placed/linked HTML is the main example.