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

Public Member Functions

 SnpManipulateInline ()
 
virtual ~SnpManipulateInline ()
 
ErrorCode InsertInline (ISnpRunnableContext *iSnpRunnableContext)
 
ErrorCode ModifyAnchorPosition (ISnpRunnableContext *iSnpRunnableContext)
 

Protected Member Functions

ErrorCode CreateFrame (IDataBase *database, UIDRef &newFrameUIDRef)
 
ErrorCode ChangeToInline (const UIDRef &storyUIDRef, const TextIndex &whereTextIndex, const UIDRef &frameUIDRef)
 

Detailed Description

  • How to create an inline within a story by processing kInsertILGCmdBoss.
  • How to manipulate the type of inline (standard, aboveline or anchored), and how to set the position using IAnchoredObjectSuite
See Also
kInsertILGCmdBoss
IAnchoredObjectSuite

Constructor & Destructor Documentation

SnpManipulateInline::SnpManipulateInline ()
inline

Constructor.

virtual SnpManipulateInline::~SnpManipulateInline ()
inlinevirtual

Destructor.

Member Function Documentation

ErrorCode SnpManipulateInline::ChangeToInline (const UIDRef & storyUIDRef,
const TextIndex & whereTextIndex,
const UIDRef & frameUIDRef 
)
protected

Insert kTextChar_Inline into the text flow and process kChangeILGCmdBoss to make the given frame into an inline on the owned item strand(IItemStrand) of the text model(ITextModel).

Parameters
storyUIDRefrefers to the story in which the inline is to be created.
whereTextIndexindex where the inline should be inserted.
frameUIDRefframe to be made into an inline. Note this frame must not be parented on any hierarchy(IHierarchy). If you have a frame that is process kRemoveFromHierarchyCmdBoss before calling this method.
Returns
kSuccess on success, other status otherwise.
ErrorCode SnpManipulateInline::CreateFrame (IDataBase * database,
UIDRef & newFrameUIDRef 
)
protected

Create a frame. Note you can create a frame that contains any type of content, or no content at all, and make it into an inline. This method makes a graphic frame.

Parameters
databasethe frame should be created in.
newFrameUIDRefOUT frame to be made into an inline.
Returns
kSuccess on success, other status otherwise.
Postcondition
the created frame is not parented on any hierarchy.
ErrorCode SnpManipulateInline::InsertInline (ISnpRunnableContext * iSnpRunnableContext)

Creates a new inline frame in the given story.

Parameters
iSnpRunnableContextIN the current context
Returns
kSuccess on success, kFailure otherwise.
ErrorCode SnpManipulateInline::ModifyAnchorPosition (ISnpRunnableContext * iSnpRunnableContext)

Allows the position of the anchored item to be modified. This sets the type of the anchored item (to one of inline, above line or anchored). The position of the inline can be specified.

Parameters
iSnpRunnableContextIN the current context
Returns
kSuccess on success, kFailure otherwise.