InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IXMLTag Class Referenceabstract

#include <IXMLTag.h>

Inheritance diagram for IXMLTag:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IXMLTAG }
 

Public Member Functions

virtual void SetTagName (const WideString &tagName)=0
 
virtual const WideStringGetTagName () const =0
 
virtual WideString GetBeginTag () const =0
 
virtual WideString GetEndTag () const =0
 
virtual WideString GetBeginMarker () const =0
 
virtual WideString GetEndMarker () const =0
 
virtual WideString GetSlashMarker () const =0
 
virtual void LockName (bool16 lock)=0
 
virtual bool16 NameLocked (void) const =0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

Represents the tag associated with an XML element (IIDXMLElement); use IXMLTagCommands to modify. See XML 1.0 specification for more detail on names for elements.

Member Function Documentation

virtual WideString IXMLTag::GetBeginMarker () const
pure virtual

Accessor for begin-marker, i.e. <

Returns
character sequence "<
virtual WideString IXMLTag::GetBeginTag () const
pure virtual

Accessor for the start tag, including the begin/end markers. For instance, this could be something like <Headline>. This is named STag in the XML 1.0 specification.

Returns
start tag
virtual WideString IXMLTag::GetEndMarker () const
pure virtual

Accessor for end-tag marker, ie. >

Returns
character sequence "&gt;"
virtual WideString IXMLTag::GetEndTag () const
pure virtual

Accessor for the end tag, including the begin/end markers. For instance, </Headline>. This is named ETag in the XML 1.0 specification.

Returns
end-tag
virtual WideString IXMLTag::GetSlashMarker () const
pure virtual

Accessor for character sequence that marks ETag, i.e. "/"

Returns
the character sequence "/"
virtual const WideString& IXMLTag::GetTagName () const
pure virtual

Accessor for name of tag, minus enclosing begin/end markers. For instance, this could be something like Headline; the element name without any begin/end markers.

Returns
the name of this tag minus begin/end markers
virtual void IXMLTag::LockName (bool16 lock)
pure virtual

Mutator for locking and unlocking the tag name. Lock state is ref counted

Parameters
lockkTrue to apply lock. kFalse to remove lock
virtual bool16 IXMLTag::NameLocked (void ) const
pure virtual

Accessor for determine whether the tag name is locked

Returns
whether the tag name is locked
virtual void IXMLTag::SetTagName (const WideStringtagName)
pure virtual

Mutator for name; use IXMLTagCommands methods to modify name from client code.

Parameters
tagNamespecifies the new tag name