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

#include <IXMLAttributeCmdData.h>

Inheritance diagram for IXMLAttributeCmdData:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IXMLATTRIBUTECMDDATA }
 

Public Member Functions

virtual void Set (const XMLReference &element, const WideString &name, const WideString &value, bool16 removable=kTrue)=0
 
virtual const XMLReferenceGetElement () const =0
 
virtual const WideStringGetName () const =0
 
virtual const WideStringGetValue () const =0
 
virtual const bool16 GetRemovable () 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

Data interface for working with the attribute of an XML element; if you're writing client code, work with IXMLAttributeCommands, and you won't need this interface.

Member Function Documentation

virtual const XMLReference& IXMLAttributeCmdData::GetElement () const
pure virtual

Return the element that owns the attribute

Returns
XMLReference to element owning attribute
virtual const WideString& IXMLAttributeCmdData::GetName () const
pure virtual

Accessor for name of element cached on this interface

Returns
the name of the attribute
virtual const bool16 IXMLAttributeCmdData::GetRemovable () const
pure virtual

Accessor for the removability of an attribute stored through this interface

Returns
kTrue if the attribute can be deleted, kFalse otherwise
virtual const WideString& IXMLAttributeCmdData::GetValue () const
pure virtual

Accessor for value of attribute cached on this interface

Returns
the value of the attribute
virtual void IXMLAttributeCmdData::Set (const XMLReferenceelement,
const WideStringname,
const WideStringvalue,
bool16 removable = kTrue 
)
pure virtual

Specify the element whose attribute should be modified and parameters required to execute the command to change attribute.

Parameters
elementspecifies the target element whose attribute is going to be changed by the command
nameidentifies the attribute
valuespecifies the value
removablekTrue if the element can be deleted from client code, kFalse otherwise