Aspose::Words::Markup::IStructuredDocumentTag Interface Referenceabstract

Detailed Description

Interface to define a common data for StructuredDocumentTag and StructuredDocumentTagRangeStart.

#include <Aspose.Words.Cpp/Markup/IStructuredDocumentTag.h>

+ Inheritance diagram for Aspose::Words::Markup::IStructuredDocumentTag:

Public Member Functions

virtual Color get_Color ()=0
 Gets the color of the structured document tag. More...
 
virtual int32_t get_Id ()=0
 Specifies a unique read-only persistent numerical Id for this SDT. More...
 
virtual bool get_IsShowingPlaceholderText ()=0
 Specifies whether the content of this SDT shall be interpreted to contain placeholder text (as opposed to regular text contents within the SDT). if set to true, this state shall be resumed (showing placeholder text) upon opening this document. More...
 
virtual MarkupLevel get_Level () const =0
 Gets the level at which this SDT occurs in the document tree. More...
 
virtual bool get_LockContentControl ()=0
 When set to true, this property will prohibit a user from deleting this SDT. More...
 
virtual bool get_LockContents ()=0
 When set to true, this property will prohibit a user from editing the contents of this SDT. More...
 
virtual SharedPtr< BuildingBlockget_Placeholder ()=0
 Gets the BuildingBlock containing placeholder text which should be displayed when this SDT run contents are empty, the associated mapped XML element is empty as specified via the XmlMapping element or the IsShowingPlaceholderText element is true. More...
 
virtual String get_PlaceholderName ()=0
 Gets Name of the BuildingBlock containing placeholder text. BuildingBlock with this name Name has to be present in the GlossaryDocument otherwise InvalidOperationException will occur. More...
 
virtual SdtType get_SdtType ()=0
 Gets type of this Structured document tag. More...
 
virtual String get_Tag () const =0
 Specifies a tag associated with the current SDT node. Can not be null. More...
 
virtual String get_Title () const =0
 Specifies the friendly name associated with this SDT. Can not be null. More...
 
virtual String get_WordOpenXML ()=0
 Gets a string that represents the XML contained within the node in the FlatOpc format. More...
 
virtual SharedPtr< XmlMappingget_XmlMapping ()=0
 Gets an object that represents the mapping of this structured document tag to XML data in a custom XML part of the current document. More...
 
virtual const TypeInfoGetType () const override
 
virtual bool Is (const TypeInfo &target) const override
 
virtual bool IsRanged ()=0
 Returns true if this instance is a ranged structured document tag. More...
 
virtual void set_Color (Color value)=0
 Sets the color of the structured document tag. More...
 
virtual void set_IsShowingPlaceholderText (bool value)=0
 Specifies whether the content of this SDT shall be interpreted to contain placeholder text (as opposed to regular text contents within the SDT). if set to true, this state shall be resumed (showing placeholder text) upon opening this document. More...
 
virtual void set_LockContentControl (bool value)=0
 When set to true, this property will prohibit a user from deleting this SDT. More...
 
virtual void set_LockContents (bool value)=0
 When set to true, this property will prohibit a user from editing the contents of this SDT. More...
 
virtual void set_PlaceholderName (String value)=0
 Sets Name of the BuildingBlock containing placeholder text. BuildingBlock with this name Name has to be present in the GlossaryDocument otherwise InvalidOperationException will occur. More...
 
virtual void set_Tag (String value)=0
 Specifies a tag associated with the current SDT node. Can not be null. More...
 
virtual void set_Title (String value)=0
 Specifies the friendly name associated with this SDT. Can not be null. More...
 
virtual SharedPtr< NodeStructuredDocumentTagNode ()=0
 Returns Node object that implements this interface. More...
 

Static Public Member Functions

static const TypeInfoType ()
 

Member Function Documentation

◆ get_Color()

virtual System::Drawing::Color Aspose::Words::Markup::IStructuredDocumentTag::get_Color ( )
pure virtual

Gets the color of the structured document tag.

Implemented in Aspose::Words::Markup::StructuredDocumentTagRangeStart, and Aspose::Words::Markup::StructuredDocumentTag.

◆ get_Id()

virtual int32_t Aspose::Words::Markup::IStructuredDocumentTag::get_Id ( )
pure virtual

Specifies a unique read-only persistent numerical Id for this SDT.

Implemented in Aspose::Words::Markup::StructuredDocumentTagRangeStart, and Aspose::Words::Markup::StructuredDocumentTag.

◆ get_IsShowingPlaceholderText()

virtual bool Aspose::Words::Markup::IStructuredDocumentTag::get_IsShowingPlaceholderText ( )
pure virtual

Specifies whether the content of this SDT shall be interpreted to contain placeholder text (as opposed to regular text contents within the SDT). if set to true, this state shall be resumed (showing placeholder text) upon opening this document.

Implemented in Aspose::Words::Markup::StructuredDocumentTagRangeStart, and Aspose::Words::Markup::StructuredDocumentTag.

◆ get_Level()

virtual Aspose::Words::Markup::MarkupLevel Aspose::Words::Markup::IStructuredDocumentTag::get_Level ( ) const
pure virtual

Gets the level at which this SDT occurs in the document tree.

Implemented in Aspose::Words::Markup::StructuredDocumentTagRangeStart, and Aspose::Words::Markup::StructuredDocumentTag.

◆ get_LockContentControl()

virtual bool Aspose::Words::Markup::IStructuredDocumentTag::get_LockContentControl ( )
pure virtual

When set to true, this property will prohibit a user from deleting this SDT.

Implemented in Aspose::Words::Markup::StructuredDocumentTagRangeStart, and Aspose::Words::Markup::StructuredDocumentTag.

◆ get_LockContents()

virtual bool Aspose::Words::Markup::IStructuredDocumentTag::get_LockContents ( )
pure virtual

When set to true, this property will prohibit a user from editing the contents of this SDT.

Implemented in Aspose::Words::Markup::StructuredDocumentTagRangeStart, and Aspose::Words::Markup::StructuredDocumentTag.

◆ get_Placeholder()

virtual System::SharedPtr<Aspose::Words::BuildingBlocks::BuildingBlock> Aspose::Words::Markup::IStructuredDocumentTag::get_Placeholder ( )
pure virtual

Gets the BuildingBlock containing placeholder text which should be displayed when this SDT run contents are empty, the associated mapped XML element is empty as specified via the XmlMapping element or the IsShowingPlaceholderText element is true.

Implemented in Aspose::Words::Markup::StructuredDocumentTagRangeStart, and Aspose::Words::Markup::StructuredDocumentTag.

◆ get_PlaceholderName()

virtual System::String Aspose::Words::Markup::IStructuredDocumentTag::get_PlaceholderName ( )
pure virtual

Gets Name of the BuildingBlock containing placeholder text. BuildingBlock with this name Name has to be present in the GlossaryDocument otherwise InvalidOperationException will occur.

Implemented in Aspose::Words::Markup::StructuredDocumentTagRangeStart, and Aspose::Words::Markup::StructuredDocumentTag.

◆ get_SdtType()

virtual Aspose::Words::Markup::SdtType Aspose::Words::Markup::IStructuredDocumentTag::get_SdtType ( )
pure virtual

Gets type of this Structured document tag.

Implemented in Aspose::Words::Markup::StructuredDocumentTagRangeStart, and Aspose::Words::Markup::StructuredDocumentTag.

◆ get_Tag()

virtual System::String Aspose::Words::Markup::IStructuredDocumentTag::get_Tag ( ) const
pure virtual

Specifies a tag associated with the current SDT node. Can not be null.

Implemented in Aspose::Words::Markup::StructuredDocumentTagRangeStart, and Aspose::Words::Markup::StructuredDocumentTag.

◆ get_Title()

virtual System::String Aspose::Words::Markup::IStructuredDocumentTag::get_Title ( ) const
pure virtual

Specifies the friendly name associated with this SDT. Can not be null.

Implemented in Aspose::Words::Markup::StructuredDocumentTagRangeStart, and Aspose::Words::Markup::StructuredDocumentTag.

◆ get_WordOpenXML()

virtual System::String Aspose::Words::Markup::IStructuredDocumentTag::get_WordOpenXML ( )
pure virtual

Gets a string that represents the XML contained within the node in the FlatOpc format.

Implemented in Aspose::Words::Markup::StructuredDocumentTagRangeStart, and Aspose::Words::Markup::StructuredDocumentTag.

◆ get_XmlMapping()

virtual System::SharedPtr<Aspose::Words::Markup::XmlMapping> Aspose::Words::Markup::IStructuredDocumentTag::get_XmlMapping ( )
pure virtual

Gets an object that represents the mapping of this structured document tag to XML data in a custom XML part of the current document.

Implemented in Aspose::Words::Markup::StructuredDocumentTagRangeStart, and Aspose::Words::Markup::StructuredDocumentTag.

◆ GetType()

virtual const System::TypeInfo& Aspose::Words::Markup::IStructuredDocumentTag::GetType ( ) const
overridevirtual

◆ Is()

virtual bool Aspose::Words::Markup::IStructuredDocumentTag::Is ( const System::TypeInfo target) const
overridevirtual

◆ IsRanged()

virtual bool Aspose::Words::Markup::IStructuredDocumentTag::IsRanged ( )
pure virtual

Returns true if this instance is a ranged structured document tag.

◆ set_Color()

virtual void Aspose::Words::Markup::IStructuredDocumentTag::set_Color ( System::Drawing::Color  value)
pure virtual

Sets the color of the structured document tag.

Implemented in Aspose::Words::Markup::StructuredDocumentTagRangeStart, and Aspose::Words::Markup::StructuredDocumentTag.

◆ set_IsShowingPlaceholderText()

virtual void Aspose::Words::Markup::IStructuredDocumentTag::set_IsShowingPlaceholderText ( bool  value)
pure virtual

Specifies whether the content of this SDT shall be interpreted to contain placeholder text (as opposed to regular text contents within the SDT). if set to true, this state shall be resumed (showing placeholder text) upon opening this document.

Implemented in Aspose::Words::Markup::StructuredDocumentTagRangeStart, and Aspose::Words::Markup::StructuredDocumentTag.

◆ set_LockContentControl()

virtual void Aspose::Words::Markup::IStructuredDocumentTag::set_LockContentControl ( bool  value)
pure virtual

When set to true, this property will prohibit a user from deleting this SDT.

Implemented in Aspose::Words::Markup::StructuredDocumentTagRangeStart, and Aspose::Words::Markup::StructuredDocumentTag.

◆ set_LockContents()

virtual void Aspose::Words::Markup::IStructuredDocumentTag::set_LockContents ( bool  value)
pure virtual

When set to true, this property will prohibit a user from editing the contents of this SDT.

Implemented in Aspose::Words::Markup::StructuredDocumentTagRangeStart, and Aspose::Words::Markup::StructuredDocumentTag.

◆ set_PlaceholderName()

virtual void Aspose::Words::Markup::IStructuredDocumentTag::set_PlaceholderName ( System::String  value)
pure virtual

Sets Name of the BuildingBlock containing placeholder text. BuildingBlock with this name Name has to be present in the GlossaryDocument otherwise InvalidOperationException will occur.

Implemented in Aspose::Words::Markup::StructuredDocumentTagRangeStart, and Aspose::Words::Markup::StructuredDocumentTag.

◆ set_Tag()

virtual void Aspose::Words::Markup::IStructuredDocumentTag::set_Tag ( System::String  value)
pure virtual

Specifies a tag associated with the current SDT node. Can not be null.

Implemented in Aspose::Words::Markup::StructuredDocumentTagRangeStart, and Aspose::Words::Markup::StructuredDocumentTag.

◆ set_Title()

virtual void Aspose::Words::Markup::IStructuredDocumentTag::set_Title ( System::String  value)
pure virtual

Specifies the friendly name associated with this SDT. Can not be null.

Implemented in Aspose::Words::Markup::StructuredDocumentTagRangeStart, and Aspose::Words::Markup::StructuredDocumentTag.

◆ StructuredDocumentTagNode()

virtual System::SharedPtr<Aspose::Words::Node> Aspose::Words::Markup::IStructuredDocumentTag::StructuredDocumentTagNode ( )
pure virtual

Returns Node object that implements this interface.

◆ Type()

static const System::TypeInfo& Aspose::Words::Markup::IStructuredDocumentTag::Type ( )
static