InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ITextVariableTable Class Referenceabstract
Inheritance diagram for ITextVariableTable:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ITEXTVARIABLETABLE }
 

Public Member Functions

virtual UID LookupVariableUID (const WideString &varName)=0
 
virtual bool16 GetBaseTypeInfo (ClassID variableClassID, VariableTypeInfo *varInfo) const =0
 
virtual int32 GetNumVariables () const =0
 
virtual ITextVariableQueryNthVariable (int32 n) const =0
 
virtual ITextVariableQueryVariable (const WideString &varName) const =0
 
virtual bool16 AddVariable (const AddVariableInfo &newInfo)=0
 
virtual bool16 AddVariable (UID newUID)=0
 
virtual bool16 RemoveVariable (const WideString &varName)=0
 
virtual bool16 ChangeVariable (const WideString &varName, const ChangeVariableInfo &chgInfo)=0
 
virtual bool16 GetNthVariableObsolete (int32 n, AddVariableInfo *varInfo) const =0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Static Public Attributes

static const int32 kInvalidIndex = -1
 

Member Function Documentation

virtual bool16 ITextVariableTable::AddVariable (const AddVariableInfonewInfo)
pure virtual

Add a variable via the AddVariableInfo data

virtual bool16 ITextVariableTable::AddVariable (UID newUID)
pure virtual

Add a variable of the following UID

virtual bool16 ITextVariableTable::ChangeVariable (const WideStringvarName,
const ChangeVariableInfo & chgInfo 
)
pure virtual

Change a variable of the following name (names are unique within the table)

virtual bool16 ITextVariableTable::GetBaseTypeInfo (ClassID variableClassID,
VariableTypeInfo * varInfo 
) const
pure virtual
Note
Unlike QueryVariable, a variable of this type doesn't have to exist in the table. This is static data instrinsic the this type of variable.
virtual bool16 ITextVariableTable::GetNthVariableObsolete (int32 n,
AddVariableInfovarInfo 
) const
pure virtual
Returns the Nth variable in the table.  Deprecated.

Note
FOR INTERNAL USE ONLY.
virtual int32 ITextVariableTable::GetNumVariables () const
pure virtual

Returns the number of variables in the table.

virtual UID ITextVariableTable::LookupVariableUID (const WideStringvarName)
pure virtual

Returns the UID of the variable

virtual ITextVariable* ITextVariableTable::QueryNthVariable (int32 n) const
pure virtual

Returns the Nth variable in the table

virtual ITextVariable* ITextVariableTable::QueryVariable (const WideStringvarName) const
pure virtual

Gets ITextVariable based on the name (names are unique within the table)

virtual bool16 ITextVariableTable::RemoveVariable (const WideStringvarName)
pure virtual

Remove the name variable (names are unique within the table)