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

Public Member Functions

 SnpManipulateTextFootnotes ()
 
virtual ~SnpManipulateTextFootnotes ()
 
ErrorCode ExploreFootnotes (ITextTarget *iTextTarget)
 
ErrorCode InsertFootnote (ITextTarget *iTextTarget, const boost::shared_ptr< WideString > &footnoteString)
 
ErrorCode DeleteStoryFootnotes (ITextTarget *iTextTarget)
 
ErrorCode FlattenStoryFootnotes (ITextTarget *iTextTarget)
 
ErrorCode ConvertSelectionToFootnote (ITextTarget *iTextTarget)
 

Detailed Description

  • How to access footnotes in a story.
  • How to detect overset footnotes within a story.
  • How to detect non-visible footnotes within a story (anchor character overset).
  • How to inspect the content of footnotes within a story.
  • How to create a footnote within a story.
  • How to delete all footnotes in a story.
  • How to flatten footnotes into a story.
  • How to convert a selection into a footnote. Footnotes are owned items, with distinct story threads.

Select the story of interest (i.e. have a valid text selection or focus).

Constructor & Destructor Documentation

SnpManipulateTextFootnotes::SnpManipulateTextFootnotes ()
inline

Constructor.

virtual SnpManipulateTextFootnotes::~SnpManipulateTextFootnotes ()
inlinevirtual

Destructor.

Member Function Documentation

ErrorCode SnpManipulateTextFootnotes::ConvertSelectionToFootnote (ITextTarget * iTextTarget)

Driver for converting the current selection to a footnote. iTextTarget identifies the insert position for the footnote reference character, and, potentially, the intial text of the footnote, if the selection has a length > 0.

Parameters
iTextTargetIN identifies the story/initial text we are interested in.
Returns
kFailure on error.
ErrorCode SnpManipulateTextFootnotes::DeleteStoryFootnotes (ITextTarget * iTextTarget)

Driver for deleting footnotes in a story. Determines which story we are interested in.

Parameters
iTextTargetIN identifies the story we are interested in.
Returns
kFailure on error.
ErrorCode SnpManipulateTextFootnotes::ExploreFootnotes (ITextTarget * iTextTarget)

Driver for dumping information about footnotes in the currently selected story.

  • In the story, where is the footnote anchor point?
  • Is the footnote visible (anchor point not overset)?
  • What is the footnote content?
    Parameters
    iTextTargetIN identifies the story we are interested in.
    Returns
    kFailure if problems are encountered.
ErrorCode SnpManipulateTextFootnotes::FlattenStoryFootnotes (ITextTarget * iTextTarget)

Driver for flattening story footnotes. Determines which story we are interested in.

Parameters
iTextTargetIN identifies the story we are interested in.
Returns
kFailure on error.
ErrorCode SnpManipulateTextFootnotes::InsertFootnote (ITextTarget * iTextTarget,
const boost::shared_ptr< WideString > & footnoteString 
)

Driver for inserting footnotes. Determines which story we are interested in.

Parameters
iTextTargetIN identifies the story we are interested in.
footnoteStringIN the string we wish to insert into the footnote
Returns
kFailure on cancel of error.