InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Facade::ITextFragmentLinkFacade Class Referenceabstract
Inheritance diagram for Facade::ITextFragmentLinkFacade:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ITEXTFRAGMENTLINKFACADE }
 

Public Member Functions

virtual ErrorCode CreateTextFragmentLink (IDataBase *db, const URI &uri, const UID &spreadLayerUID, const WideString *tagName=NULL, const WideString *customCMSData=NULL, const PMRect *viewBounds=NULL, PMString textFragmentCmdSeqName=PMString("")) const =0
 
virtual ErrorCode RelinkTextFragmentLink (IDataBase *db, ILinkObject *linkObject, const URI &uri, const WideString *tagName=NULL) const =0
 
virtual ErrorCode InsertText (const ITextModel *textModel, const RangeData &rangeData, const WideString &metadataContent, RangeData &newRange) const =0
 
virtual ErrorCode DeleteText (ITextModel *textModel, const RangeData &rangeData, RangeData &newRange) const =0
 
virtual ErrorCode FetchAssetMetadataContent (const URI &uri, WideString &metadataContent) const =0
 
virtual ErrorCode CreateLinkResourceAndFetchMetadataContent (IDataBase *db, const URI &uri, const WideString *tagName, UID &linkResourceUID, WideString &metadataKey, WideString &metadataContent) const =0
 
virtual ErrorCode InsertTextAndCreateLink (IDataBase *db, const URI &uri, const ITextModel *textModel, const RangeData &currentRange, XMLReference &newElementReference, UID &linkUID, RangeData &newRange, bool createTag=true, const WideString *tagName=NULL, const WideString *customCMSData=NULL) const =0
 
virtual ErrorCode CreateMetadataLinkFromXMLReference (const XMLReference &newElementReference, IDataBase *db, const UID &linkResourceUID, UID &linkUID) const =0
 
virtual ErrorCode CreateXMLAttributes (const XMLReference &xmlRef, const WideString *uriWideString, const WideString *customCMSData, bool isTextFragmentLink=true) const =0
 
virtual ErrorCode DeleteXMLrefandAssociateLinkobject (const UIDRef &linkObjectUIDRef) const =0
 
virtual bool16 IsTextFragmentLinkObject (const UIDRef &linkObjectUIDRef) const =0
 
virtual bool16 IsTextFragmentLinkObject (const XMLReference &xmlRef) const =0
 
virtual IHierarchyGetTextFragmentHierarchy (const ILinkObject *linkObject) const =0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Member Function Documentation

virtual ErrorCode Facade::ITextFragmentLinkFacade::CreateLinkResourceAndFetchMetadataContent (IDataBasedb,
const URIuri,
const WideStringtagName,
UIDlinkResourceUID,
WideStringmetadataKey,
WideStringmetadataContent 
) const
pure virtual

Creates the LinkResource and also fills the metadataContent and also set the metadataKey.

virtual ErrorCode Facade::ITextFragmentLinkFacade::CreateMetadataLinkFromXMLReference (const XMLReferencenewElementReference,
IDataBasedb,
const UIDlinkResourceUID,
UIDlinkUID 
) const
pure virtual

Create the MetaData Link based on XMLref and results linkUID.

virtual ErrorCode Facade::ITextFragmentLinkFacade::CreateTextFragmentLink (IDataBasedb,
const URIuri,
const UIDspreadLayerUID,
const WideStringtagName = NULL,
const WideStringcustomCMSData = NULL,
const PMRectviewBounds = NULL,
PMString textFragmentCmdSeqName = PMString("") 
) const
pure virtual

Create the text fragment link

virtual ErrorCode Facade::ITextFragmentLinkFacade::CreateXMLAttributes (const XMLReferencexmlRef,
const WideStringuriWideString,
const WideStringcustomCMSData,
bool isTextFragmentLink = true 
) const
pure virtual

**Creates the XML Attributes

virtual ErrorCode Facade::ITextFragmentLinkFacade::DeleteText (ITextModeltextModel,
const RangeDatarangeData,
RangeDatanewRange 
) const
pure virtual

Delete text and set the newRange after deletion.

virtual ErrorCode Facade::ITextFragmentLinkFacade::DeleteXMLrefandAssociateLinkobject (const UIDReflinkObjectUIDRef) const
pure virtual

Delete the tags/XMLRef surrounding/ associated with the LinkObject.

virtual ErrorCode Facade::ITextFragmentLinkFacade::FetchAssetMetadataContent (const URIuri,
WideStringmetadataContent 
) const
pure virtual

Fetch the content into metadataContent for the metadatakey appended in uri.

virtual IHierarchy* Facade::ITextFragmentLinkFacade::GetTextFragmentHierarchy (const ILinkObjectlinkObject) const
pure virtual

return the Text Fragment Link Object Hierarchy

virtual ErrorCode Facade::ITextFragmentLinkFacade::InsertText (const ITextModeltextModel,
const RangeDatarangeData,
const WideStringmetadataContent,
RangeDatanewRange 
) const
pure virtual

**Insert the text specified with metadataContent into range specified by rangeData and set the newRange after insertion.

virtual ErrorCode Facade::ITextFragmentLinkFacade::InsertTextAndCreateLink (IDataBasedb,
const URIuri,
const ITextModeltextModel,
const RangeDatacurrentRange,
XMLReferencenewElementReference,
UIDlinkUID,
RangeDatanewRange,
bool createTag = true,
const WideStringtagName = NULL,
const WideStringcustomCMSData = NULL 
) const
pure virtual

**Insert Text and gives the range of inserted text and for inserted text it create a Link.

virtual bool16 Facade::ITextFragmentLinkFacade::IsTextFragmentLinkObject (const UIDReflinkObjectUIDRef) const
pure virtual

**Checks whether the Link Object w.r.t linkObjectUIDRef is a text Fragment Link Object.

virtual bool16 Facade::ITextFragmentLinkFacade::IsTextFragmentLinkObject (const XMLReferencexmlRef) const
pure virtual

Checks whether the LinkObject corresponding to the XMLRef is a text Fragment Link Object.

virtual ErrorCode Facade::ITextFragmentLinkFacade::RelinkTextFragmentLink (IDataBasedb,
ILinkObjectlinkObject,
const URIuri,
const WideStringtagName = NULL 
) const
pure virtual

**relink the text fragment link