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

#include <TableTagData.h>

Public Member Functions

 TableTagData (IDataBase *db=nil)
 
void Initialize (IDataBase *db)
 
bool16 IsInitialized (void) const
 
void SetTableTag (const WideString &name)
 
void SetHeaderTag (const WideString &name)
 
void SetBodyTag (const WideString &name)
 
void SetFooterTag (const WideString &name)
 
void SetRowTag (const WideString &name)
 
void SetCellTag (const WideString &name)
 
void SetTableTag (const UID &uid)
 
void SetHeaderTag (UID uid)
 
void SetBodyTag (UID uid)
 
void SetFooterTag (UID uid)
 
void SetRowTag (const UID &uid)
 
void SetCellTag (const UID &uid)
 
UID GetTableTag (bool16 lwProcessing=kFalse) const
 
bool16 HasTableTag (void) const
 
UID GetHeaderTag (bool16 lwProcessing=kFalse) const
 
bool16 HasHeaderTag (void) const
 
UID GetBodyTag (bool16 lwProcessing=kFalse) const
 
bool16 HasBodyTag (void) const
 
UID GetFooterTag (bool16 lwProcessing=kFalse) const
 
bool16 HasFooterTag (void) const
 
UID GetRowTag (bool16 lwProcessing=kFalse) const
 
bool16 HasRowTag (void) const
 
UID GetCellTag (bool16 lwProcessing=kFalse) const
 
bool16 HasCellTag (void) const
 

Detailed Description

Use this class to indicate which tags should be used to tag a given table You can either use the default class which will tag tables with the tags chosen by the user or you can specify your own tags by name or UID

Constructor & Destructor Documentation

TableTagData::TableTagData (IDataBase * db = nil)

constructor

Parameters
db- Used to specify which database tags should be retrieved from

Member Function Documentation

UID TableTagData::GetBodyTag (bool16 lwProcessing = kFalse) const
inline

Use this to get the UID of the tag that should be used to tag the table body NOTE: Typically this should not be called by anything but a command because it may change the document.

Parameters
lwProcessing- kTrue Indicates that this command should be processed without notification. kFalse indicates that notification is OK. Note: If you pass kTrue no command will be fired so you must make sure you don't call this unless you are in a command sequence.
Returns
The UID of the tag to use for tagging the table body
UID TableTagData::GetCellTag (bool16 lwProcessing = kFalse) const
inline

Use this to get the UID of the tag that should be used to tag the cell NOTE: Typically this should not be called by anything but a command because it may change the document.

Parameters
lwProcessing- kTrue Indicates that this command should be processed without notification. kFalse indicates that notification is OK. Note: If you pass kTrue no command will be fired so you must make sure you don't call this unless you are in a command sequence.
Returns
The UID of the tag to use for tagging the cell.
UID TableTagData::GetFooterTag (bool16 lwProcessing = kFalse) const
inline

Use this to get the UID of the tag that should be used to tag the table footer NOTE: Typically this should not be called by anything but a command because it may change the document.

Parameters
lwProcessing- kTrue Indicates that this command should be processed without notification. kFalse indicates that notification is OK. Note: If you pass kTrue no command will be fired so you must make sure you don't call this unless you are in a command sequence.
Returns
The UID of the tag to use for tagging the table footer
UID TableTagData::GetHeaderTag (bool16 lwProcessing = kFalse) const
inline

Use this to get the UID of the tag that should be used to tag the table header NOTE: Typically this should not be called by anything but a command because it may change the document.

Parameters
lwProcessing- kTrue Indicates that this command should be processed without notification. kFalse indicates that notification is OK. Note: If you pass kTrue no command will be fired so you must make sure you don't call this unless you are in a command sequence.
Returns
The UID of the tag to use for tagging the table header
UID TableTagData::GetRowTag (bool16 lwProcessing = kFalse) const
inline

Use this to get the UID of the tag that should be used to tag the row NOTE: Typically this should not be called by anything but a command because it may change the document.

Parameters
lwProcessing- kTrue Indicates that this command should be processed without notification. kFalse indicates that notification is OK. Note: If you pass kTrue no command will be fired so you must make sure you don't call this unless you are in a command sequence.
Returns
The UID of the tag to use for tagging the row.
UID TableTagData::GetTableTag (bool16 lwProcessing = kFalse) const
inline

Use this to get the UID of the tag that should be used to tag the table NOTE: Typically this should not be called by anything but a command because it may change the document.

Parameters
lwProcessing- kTrue Indicates that this command should be processed without notification. kFalse indicates that notification is OK. Note: If you pass kTrue no command will be fired so you must make sure you don't call this unless you are in a command sequence.
Returns
The UID of the tag to use for tagging the table.
bool16 TableTagData::HasBodyTag (void ) const
inline

Returns whether a table body tag was specified in this

Returns
whether a table body tag was specified in this
bool16 TableTagData::HasCellTag (void ) const
inline

Returns whether a table cell tag was specified in this

Returns
whether a table cell tag was specified in this
bool16 TableTagData::HasFooterTag (void ) const
inline

Returns whether a table footer tag was specified in this

Returns
whether a table footer tag was specified in this
bool16 TableTagData::HasHeaderTag (void ) const
inline

Returns whether a table header tag was specified in this

Returns
whether a table header tag was specified in this
bool16 TableTagData::HasRowTag (void ) const
inline

Returns whether a table row tag was specified in this

Returns
whether a table row tag was specified in this
bool16 TableTagData::HasTableTag (void ) const
inline

Returns whether a table tag was specified in this

Returns
whether a table tag was specified in this
void TableTagData::Initialize (IDataBase * db)

Use this to initialize the data in this class

Parameters
db- Used to specify which database tags should be retrieved from
bool16 TableTagData::IsInitialized (void ) const

Use this to determine if this has been initialized. This can be initialized by calling Initialize()

Returns
whether this has been initialized
void TableTagData::SetBodyTag (const WideString & name)
inline

Use this to set the table body tag. You can specify the tag by name

Parameters
name- This is the name your table body tag should have
void TableTagData::SetBodyTag (UID uid)
inline

Use this to set the table body tag. You can specify the tag by UID

Parameters
uid- The UID of the tag you want to use to tag the table body
void TableTagData::SetCellTag (const WideString & name)
inline

Use this to override the default cell tag. You can specify the tag by name

Parameters
name- This is the name your cell tag should have
void TableTagData::SetCellTag (const UID & uid)
inline

Use this to override the default Cell tag. You can specify the tag by UID

Parameters
uid- The UID of the tag you want to use to tag the cell
void TableTagData::SetFooterTag (const WideString & name)
inline

Use this to set the table footer tag. You can specify the tag by name

Parameters
name- This is the name your table footer tag should have
void TableTagData::SetFooterTag (UID uid)
inline

Use this to set the table footer tag. You can specify the tag by UID

Parameters
uid- The UID of the tag you want to use to tag the table footer
void TableTagData::SetHeaderTag (const WideString & name)
inline

Use this to set the table header tag. You can specify the tag by name

Parameters
name- This is the name your table header tag should have
void TableTagData::SetHeaderTag (UID uid)
inline

Use this to set the table header tag. You can specify the tag by UID

Parameters
uid- The UID of the tag you want to use to tag the table header
void TableTagData::SetRowTag (const WideString & name)
inline

Use this to override the default row tag. You can specify the tag by name

Parameters
name- This is the name your row tag should have
void TableTagData::SetRowTag (const UID & uid)
inline

Use this to override the default Row tag. You can specify the tag by UID

Parameters
uid- The UID of the tag you want to use to tag the row
void TableTagData::SetTableTag (const WideString & name)
inline

Use this to override the default table tag. You can specify the tag by name

Parameters
name- This is the name your table tag should have
void TableTagData::SetTableTag (const UID & uid)
inline

Use this to override the default Table tag. You can specify the tag by UID

Parameters
uid- The UID of the tag you want to use to tag the table