InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
SnpCreateAndManipulateSharedLink Class Reference

Public Member Functions

ErrorCode CreateSharedContentLink (const UIDRef &sourceRectangleFrameRef, UID &outLinkUID)
 
ErrorCode CheckLinkType (const UIDRef &sourceRectangleFrameRef)
 
bool16 IsRectangleFrame (const UIDRef &graphicFrameUIDRef)
 
 SnpCreateAndManipulateSharedLink ()
 
virtual ~SnpCreateAndManipulateSharedLink ()
 

Detailed Description

  • How to create an internal or external link for rectangle,
  • How to check the link type is internal or external,

Constructor & Destructor Documentation

SnpCreateAndManipulateSharedLink::SnpCreateAndManipulateSharedLink ()
inline

Constructor.

virtual SnpCreateAndManipulateSharedLink::~SnpCreateAndManipulateSharedLink ()
inlinevirtual

Destructor.

Member Function Documentation

ErrorCode SnpCreateAndManipulateSharedLink::CheckLinkType (const UIDRefsourceRectangleFrameRef)

Check the link type for the given rectangle frame.

Parameters
sourceRectangleFrameRefreference to the rectangle frame.
Returns
kSuccess on success, other ErrorCode otherwise.
ErrorCode SnpCreateAndManipulateSharedLink::CreateSharedContentLink (const UIDRefsourceRectangleFrameRef,
UIDoutLinkUID 
)

Create a linked rectangle frame for the given rectangle frame.

Parameters
sourceRectangleFrameRefreference to the rectangle frame.
outLinkUIDreference to the link UID between source and target rectangle frame.
Returns
kSuccess on success, other ErrorCode otherwise.
bool16 SnpCreateAndManipulateSharedLink::IsRectangleFrame (const UIDRefgraphicFrameUIDRef)
Return kTrue if the given frame is a rectangle frame, kFalse otherwise.

Parameters
graphicFrameUIDRefreference to the rectangle frame's kSplineItemBoss object.