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

Public Member Functions

 SnpManipulateTextEndnotes ()
 
virtual ~SnpManipulateTextEndnotes ()
 
ErrorCode ExploreEndnotes (ITextTarget *iTextTarget)
 
ErrorCode InsertEndnote (ITextTarget *iTextTarget, const boost::shared_ptr< WideString > &endnoteString)
 
ErrorCode DeleteStoryEndnotes (ITextTarget *iTextTarget)
 
ErrorCode FlattenStoryEndnotes (ITextTarget *iTextTarget)
 
ErrorCode ConvertSelectionToEndnote (ITextTarget *iTextTarget)
 

Detailed Description

  • How to access endnotes in a story.
  • How to inspect the content of endnotes within a story.
  • How to create a endnote within a story.
  • How to delete all endnotes in a story.
  • How to flatten endnotes into a story.
  • How to convert a selection into a endnote. Endnotes are text ranges in a separate endnotes story.

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

Constructor & Destructor Documentation

SnpManipulateTextEndnotes::SnpManipulateTextEndnotes ()
inline

Constructor.

virtual SnpManipulateTextEndnotes::~SnpManipulateTextEndnotes ()
inlinevirtual

Destructor.

Member Function Documentation

ErrorCode SnpManipulateTextEndnotes::ConvertSelectionToEndnote (ITextTarget * iTextTarget)

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

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

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

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

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

  • In the story, where is the endnote anchor point?
  • What is the endnote content?
    Parameters
    iTextTargetIN identifies the story we are interested in.
    Returns
    kFailure if problems are encountered.
ErrorCode SnpManipulateTextEndnotes::FlattenStoryEndnotes (ITextTarget * iTextTarget)

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

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

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

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