Aspose::Words::Markup::StructuredDocumentTag Class Reference

Represents a structured document tag (SDT or content control) in a document. More...

#include "Aspose.Words.Cpp/Model/Markup/Sdt/StructuredDocumentTag.h"

Inherits Aspose::Words::CompositeNode, IMarkupNode, ITrackableNode, and IRunAttrSource.

Public Member Functions

virtual Aspose::Words::NodeType get_NodeType () const
 Returns NodeType.StructuredDocumentTag. More...
 
System::SharedPtr< Aspose::Words::BuildingBlocks::BuildingBlockget_Placeholder () const
 Gets the Aspose::Words::BuildingBlocks::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 Aspose::Words::Markup::StructuredDocumentTag::get_XmlMapping element or the Aspose::Words::Markup::StructuredDocumentTag::get_IsShowingPlaceholderText element is true. More...
 
System::String get_PlaceholderName () const
 
void set_PlaceholderName (System::String value)
 Setter for Aspose::Words::Markup::StructuredDocumentTag::get_PlaceholderName. More...
 
Aspose::Words::Markup::MarkupLevel get_Level () const
 Gets the level at which this SDT occurs in the document tree. More...
 
Aspose::Words::Markup::SdtType get_SdtType ()
 Gets type of this Structured document tag. More...
 
int32_t get_Id ()
 
bool get_LockContentControl () const
 When set to true, this property will prohibit a user from deleting this SDT. More...
 
void set_LockContentControl (bool value)
 Setter for Aspose::Words::Markup::StructuredDocumentTag::get_LockContentControl. More...
 
bool get_LockContents () const
 When set to true, this property will prohibit a user from editing the contents of this SDT. More...
 
void set_LockContents (bool value)
 Setter for Aspose::Words::Markup::StructuredDocumentTag::get_LockContents. More...
 
bool get_IsShowingPlaceholderText () const
 
void set_IsShowingPlaceholderText (bool value)
 Setter for Aspose::Words::Markup::StructuredDocumentTag::get_IsShowingPlaceholderText. More...
 
System::String get_Tag () const
 Specifies a tag associated with the current SDT node. Can not be null. More...
 
void set_Tag (System::String value)
 Setter for Aspose::Words::Markup::StructuredDocumentTag::get_Tag. More...
 
System::SharedPtr< Aspose::Words::Fontget_ContentsFont ()
 Font formatting that will be applied to text entered into SDT. More...
 
System::SharedPtr< Aspose::Words::Fontget_EndCharacterFont ()
 Font formatting that will be applied to the last character of text entered into SDT. More...
 
bool get_IsTemporary () const
 Specifies whether this SDT shall be removed from the WordprocessingML document when its contents are modified. More...
 
void set_IsTemporary (bool value)
 Setter for Aspose::Words::Markup::StructuredDocumentTag::get_IsTemporary. More...
 
System::String get_Title () const
 Specifies the friendly name associated with this SDT. Can not be null. More...
 
void set_Title (System::String value)
 Setter for Aspose::Words::Markup::StructuredDocumentTag::get_Title. More...
 
System::SharedPtr< Aspose::Words::Markup::SdtListItemCollectionget_ListItems ()
 Gets Aspose::Words::Markup::SdtListItemCollection associated with this SDT. More...
 
bool get_Checked ()
 Gets/Sets current state of the Checkbox SDT. Default value for this property is false. More...
 
void set_Checked (bool value)
 Setter for Aspose::Words::Markup::StructuredDocumentTag::get_Checked. More...
 
int32_t get_DateDisplayLocale ()
 Allows to set/get the language format for the date displayed in this SDT. More...
 
void set_DateDisplayLocale (int32_t value)
 Setter for Aspose::Words::Markup::StructuredDocumentTag::get_DateDisplayLocale. More...
 
System::String get_DateDisplayFormat ()
 String that represents the format in which dates are displayed. Can not be null. More...
 
void set_DateDisplayFormat (System::String value)
 Setter for Aspose::Words::Markup::StructuredDocumentTag::get_DateDisplayFormat. More...
 
System::DateTime get_FullDate ()
 Specifies the full date and time last entered into this SDT. More...
 
void set_FullDate (System::DateTime value)
 Setter for Aspose::Words::Markup::StructuredDocumentTag::get_FullDate. More...
 
Aspose::Words::Markup::SdtDateStorageFormat get_DateStorageFormat ()
 Gets/sets format in which the date for a date SDT is stored when the SDT is bound to an XML node in the document's data store. Default value is Aspose::Words::Markup::SdtDateStorageFormat::DateTime More...
 
void set_DateStorageFormat (Aspose::Words::Markup::SdtDateStorageFormat value)
 Setter for Aspose::Words::Markup::StructuredDocumentTag::get_DateStorageFormat. More...
 
Aspose::Words::Markup::SdtCalendarType get_CalendarType ()
 Specifies the type of calendar for this SDT. Default is Aspose::Words::Markup::SdtCalendarType::Default More...
 
void set_CalendarType (Aspose::Words::Markup::SdtCalendarType value)
 Setter for Aspose::Words::Markup::StructuredDocumentTag::get_CalendarType. More...
 
System::String get_BuildingBlockGallery ()
 Specifies type of building block for this SDT. Can not be null. More...
 
void set_BuildingBlockGallery (System::String value)
 Setter for Aspose::Words::Markup::StructuredDocumentTag::get_BuildingBlockGallery. More...
 
System::String get_BuildingBlockCategory ()
 Specifies category of building block for this SDT node. Can not be null. More...
 
void set_BuildingBlockCategory (System::String value)
 Setter for Aspose::Words::Markup::StructuredDocumentTag::get_BuildingBlockCategory. More...
 
bool get_Multiline ()
 Specifies whether this SDT allows multiple lines of text. More...
 
void set_Multiline (bool value)
 Setter for Aspose::Words::Markup::StructuredDocumentTag::get_Multiline. More...
 
System::Drawing::Color get_Color ()
 Gets or sets the color of the structured document tag. More...
 
void set_Color (System::Drawing::Color value)
 Setter for Aspose::Words::Markup::StructuredDocumentTag::get_Color. More...
 
System::SharedPtr< Aspose::Words::Styleget_Style ()
 Gets or sets the Style of the structured document tag. More...
 
void set_Style (System::SharedPtr< Aspose::Words::Style > value)
 Setter for Aspose::Words::Markup::StructuredDocumentTag::get_Style. More...
 
System::String get_StyleName ()
 Gets or sets the name of the style applied to the structured document tag. More...
 
void set_StyleName (System::String value)
 Setter for Aspose::Words::Markup::StructuredDocumentTag::get_StyleName. More...
 
System::SharedPtr< Aspose::Words::Markup::XmlMappingget_XmlMapping () const
 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...
 
Aspose::Words::Markup::MarkupLevel get_Level_IMarkupNode ()
 
System::SharedPtr< Aspose::Words::Revisions::EditRevision > get_InsertRevision ()
 
void set_InsertRevision (System::SharedPtr< Aspose::Words::Revisions::EditRevision > value)
 
System::SharedPtr< Aspose::Words::Revisions::EditRevision > get_DeleteRevision ()
 
void set_DeleteRevision (System::SharedPtr< Aspose::Words::Revisions::EditRevision > value)
 
System::SharedPtr< Aspose::Words::Revisions::MoveRevision > get_MoveFromRevision ()
 
void set_MoveFromRevision (System::SharedPtr< Aspose::Words::Revisions::MoveRevision > value)
 
System::SharedPtr< Aspose::Words::Revisions::MoveRevision > get_MoveToRevision ()
 
void set_MoveToRevision (System::SharedPtr< Aspose::Words::Revisions::MoveRevision > value)
 
 StructuredDocumentTag (System::SharedPtr< Aspose::Words::DocumentBase > doc, Aspose::Words::Markup::SdtType type, Aspose::Words::Markup::MarkupLevel level)
 Initializes a new instance of the Structured document tag class. More...
 
void RemoveSelfOnly ()
 Removes just this SDT node itself, but keeps the content of it inside the document tree. More...
 
virtual bool Accept (System::SharedPtr< Aspose::Words::DocumentVisitor > visitor)
 Accepts a visitor. More...
 
void Clear ()
 Clears contents of this structured document tag and displays a placeholder if it is defined. More...
 
System::SharedPtr< System::ObjectGetDirectRunAttr (int32_t key)
 
System::SharedPtr< System::ObjectFetchInheritedRunAttr (int32_t key)
 
void SetRunAttr (int32_t key, System::SharedPtr< System::Object > value)
 
void RemoveRunAttr (int32_t key)
 
void ClearRunAttrs ()
 
- Public Member Functions inherited from Aspose::Words::CompositeNode
virtual bool get_IsComposite ()
 Returns true as this node can have child nodes. More...
 
bool get_HasChildNodes ()
 Returns true if this node has any child nodes. More...
 
System::SharedPtr< Aspose::Words::NodeCollectionget_ChildNodes ()
 Gets all immediate child nodes of this node. More...
 
System::SharedPtr< Aspose::Words::Nodeget_FirstChild () const
 Gets the first child of the node. More...
 
System::SharedPtr< Aspose::Words::Nodeget_LastChild () const
 Gets the last child of the node. More...
 
int32_t get_Count ()
 Gets the number of immediate children of this node. More...
 
System::SharedPtr< Aspose::Words::CompositeNodeget_Container ()
 
virtual ~CompositeNode ()
 
virtual System::String GetText ()
 Gets the text of this node and of all its children. More...
 
System::SharedPtr< Aspose::Words::NodeCollectionGetChildNodes (Aspose::Words::NodeType nodeType, bool isDeep)
 Returns a live collection of child nodes that match the specified type. More...
 
System::SharedPtr< Aspose::Words::NodeGetChild (Aspose::Words::NodeType nodeType, int32_t index, bool isDeep)
 Returns an Nth child node that matches the specified type. More...
 
System::SharedPtr< Aspose::Words::NodeListSelectNodes (System::String xpath)
 Selects a list of nodes matching the XPath expression. More...
 
System::SharedPtr< Aspose::Words::NodeSelectSingleNode (System::String xpath)
 Selects the first Node that matches the XPath expression. More...
 
System::SharedPtr< System::Collections::Generic::IEnumerator< System::SharedPtr< Aspose::Words::Node > > > GetEnumerator ()
 Provides support for the for each style iteration over the child nodes of this node. More...
 
System::SharedPtr< Aspose::Words::NodeAppendChild (System::SharedPtr< Aspose::Words::Node > newChild)
 Adds the specified node to the end of the list of child nodes for this node. More...
 
System::SharedPtr< Aspose::Words::NodePrependChild (System::SharedPtr< Aspose::Words::Node > newChild)
 Adds the specified node to the beginning of the list of child nodes for this node. More...
 
System::SharedPtr< Aspose::Words::NodeInsertAfter (System::SharedPtr< Aspose::Words::Node > newChild, System::SharedPtr< Aspose::Words::Node > refChild)
 Inserts the specified node immediately after the specified reference node. More...
 
System::SharedPtr< Aspose::Words::NodeInsertBefore (System::SharedPtr< Aspose::Words::Node > newChild, System::SharedPtr< Aspose::Words::Node > refChild)
 Inserts the specified node immediately before the specified reference node. More...
 
System::SharedPtr< Aspose::Words::NodeRemoveChild (System::SharedPtr< Aspose::Words::Node > oldChild)
 Removes the specified child node. More...
 
void RemoveAllChildren ()
 Removes all the child nodes of the current node. More...
 
void RemoveSmartTags ()
 Removes all Aspose::Words::Markup::SmartTag descendant nodes of the current node. More...
 
int32_t IndexOf (System::SharedPtr< Aspose::Words::Node > child)
 Returns the index of the specified child node in the child node array. More...
 
System::SharedPtr< Aspose::Words::NodeGetNextMatchingNode (System::SharedPtr< Aspose::Words::Node > &curNode)
 
- Public Member Functions inherited from Aspose::Words::Node
System::SharedPtr< Aspose::Words::CompositeNodeget_ParentNode ()
 Gets the immediate parent of this node. More...
 
virtual System::SharedPtr< Aspose::Words::DocumentBaseget_Document ()
 Gets the document to which this node belongs. More...
 
System::SharedPtr< Aspose::Words::Nodeget_PreviousSibling ()
 Gets the node immediately preceding this node. More...
 
System::SharedPtr< Aspose::Words::Nodeget_NextSibling ()
 Gets the node immediately following this node. More...
 
System::SharedPtr< Aspose::Words::Rangeget_Range ()
 Returns a Range object that represents the portion of a document that is contained in this node. More...
 
System::SharedPtr< Aspose::Words::NodeClone (bool isCloneChildren)
 
template<typename T >
GetAncestorOf ()
 
System::SharedPtr< Aspose::Words::CompositeNodeGetAncestor (Aspose::Words::NodeType ancestorType)
 Gets the first ancestor of the specified Aspose::Words::NodeType. More...
 
void Remove ()
 Removes itself from the parent. More...
 
System::SharedPtr< Aspose::Words::NodeNextPreOrder (System::SharedPtr< Aspose::Words::Node > rootNode)
 Gets next node according to the pre-order tree traversal algorithm. More...
 
System::SharedPtr< Aspose::Words::NodePreviousPreOrder (System::SharedPtr< Aspose::Words::Node > rootNode)
 Gets the previous node according to the pre-order tree traversal algorithm. More...
 
System::String ToString (Aspose::Words::SaveFormat saveFormat)
 Exports the content of the node into a string in the specified format. More...
 
System::String ToString (System::SharedPtr< Aspose::Words::Saving::SaveOptions > saveOptions)
 Exports the content of the node into a string using the specified save options. More...
 
- Public Member Functions inherited from System::Object
 Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ~Object ()
 Destroys object. Frees all internal data structures. More...
 
 Object (Object const &x)
 Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int SharedRefRemovedSafe ()
 Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int RemovedSharedRefs (int count)
 Decreases shared reference count by specified value. More...
 
Detail::SmartPtrCounter * WeakRefAdded ()
 Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
void WeakRefRemoved ()
 Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
Detail::SmartPtrCounter * GetCounter ()
 Gets reference counter data structure associated with the object. More...
 
int SharedCount () const
 Gets current value of shared refernce counter. More...
 
void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual int GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual String ToString () ASPOSE_CONST
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual void SetTemplateWeakPtr (unsigned int argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
typedef System::Details::SharedMembersType shared_members_type
 structure to keep list of shared pointers contained in object. More...
 
- Public Types inherited from System::Collections::Generic::IEnumerable< System::SharedPtr< Aspose::Words::Node > >
typedef IEnumerator< System::SharedPtr< Aspose::Words::Node > > IEnumeratorType
 Enumerator type. More...
 
- Static Public Member Functions inherited from Aspose::Words::Node
static System::String NodeTypeToString (Aspose::Words::NodeType nodeType)
 A utility method that converts a node type enum value into a user friendly string. More...
 
- Static Public Member Functions inherited from System::Object
static bool ReferenceEquals (ptr const &objA, ptr const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, T const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, std::nullptr_t)
 Reference-compares value type object with nullptr. More...
 
template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares reference type objects in C# style. More...
 
template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares value type objects in C# style. More...
 
static const TypeInfoType ()
 Impleemnts C# typeof(System.Object) construct. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 
template<>
bool Equals (double const &objA, double const &objB)
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 

Detailed Description

Represents a structured document tag (SDT or content control) in a document.

Structured document tags (SDTs) allow to embed customer-defined semantics as well as its behavior and appearance into a document.

In this version Aspose.Words provides a number of public methods and properties to manipulate the behavior and content of Aspose::Words::Markup::StructuredDocumentTag. Mapping of SDT nodes to custom XML packages within a document can be performed with using the Aspose::Words::Markup::StructuredDocumentTag::get_XmlMapping property.

Aspose::Words::Markup::StructuredDocumentTag can occur in a document in the following places:

Constructor & Destructor Documentation

◆ StructuredDocumentTag()

Aspose::Words::Markup::StructuredDocumentTag::StructuredDocumentTag ( System::SharedPtr< Aspose::Words::DocumentBase doc,
Aspose::Words::Markup::SdtType  type,
Aspose::Words::Markup::MarkupLevel  level 
)

Member Function Documentation

◆ Accept()

virtual bool Aspose::Words::Markup::StructuredDocumentTag::Accept ( System::SharedPtr< Aspose::Words::DocumentVisitor visitor)
virtual

Accepts a visitor.

Enumerates over this node and all of its children. Each node calls a corresponding method on DocumentVisitor.

For more info see the Visitor design pattern.

Parameters
visitorThe visitor that will visit the nodes.
Returns
True if all nodes were visited; false if DocumentVisitor stopped the operation before visiting all nodes.

Calls Aspose::Words::DocumentVisitor::VisitStructuredDocumentTagStart(System::SharedPtr<Aspose::Words::Markup::StructuredDocumentTag>), then calls Aspose::Words::Node::Accept(System::SharedPtr<Aspose::Words::DocumentVisitor>) for all child nodes of the smart tag and calls Aspose::Words::DocumentVisitor::VisitStructuredDocumentTagEnd(System::SharedPtr<Aspose::Words::Markup::StructuredDocumentTag>) at the end.

Implements Aspose::Words::Node.

◆ Clear()

void Aspose::Words::Markup::StructuredDocumentTag::Clear ( )

Clears contents of this structured document tag and displays a placeholder if it is defined.

It is not possible to clear contents of a structured document tag if it has revisions.

If this structured document tag is mapped to custom XML (with using the Aspose::Words::Markup::StructuredDocumentTag::get_XmlMapping property), the referenced XML node is cleared.

◆ ClearRunAttrs()

void Aspose::Words::Markup::StructuredDocumentTag::ClearRunAttrs ( )

◆ FetchInheritedRunAttr()

System::SharedPtr<System::Object> Aspose::Words::Markup::StructuredDocumentTag::FetchInheritedRunAttr ( int32_t  key)

◆ get_BuildingBlockCategory()

System::String Aspose::Words::Markup::StructuredDocumentTag::get_BuildingBlockCategory ( )

Specifies category of building block for this SDT node. Can not be null.

Accessing this property will only work for Aspose::Words::Markup::SdtType::BuildingBlockGallery and Aspose::Words::Markup::SdtType::DocPartObj SDT types. It is read-only for SDT of the document part type.

For all other SDT types exception will occur.

◆ get_BuildingBlockGallery()

System::String Aspose::Words::Markup::StructuredDocumentTag::get_BuildingBlockGallery ( )

Specifies type of building block for this SDT. Can not be null.

Accessing this property will only work for Aspose::Words::Markup::SdtType::BuildingBlockGallery and Aspose::Words::Markup::SdtType::DocPartObj SDT types. It is read-only for SDT of the document part type.

For all other SDT types exception will occur.

◆ get_CalendarType()

Aspose::Words::Markup::SdtCalendarType Aspose::Words::Markup::StructuredDocumentTag::get_CalendarType ( )

Specifies the type of calendar for this SDT. Default is Aspose::Words::Markup::SdtCalendarType::Default

Accessing this property will only work for Aspose::Words::Markup::SdtType::Date SDT type.

For all other SDT types exception will occur.

◆ get_Checked()

bool Aspose::Words::Markup::StructuredDocumentTag::get_Checked ( )

Gets/Sets current state of the Checkbox SDT. Default value for this property is false.

Accessing this property will only work for Aspose::Words::Markup::SdtType::Checkbox SDT types.

For all other SDT types exception will occur.

◆ get_Color()

System::Drawing::Color Aspose::Words::Markup::StructuredDocumentTag::get_Color ( )

Gets or sets the color of the structured document tag.

◆ get_ContentsFont()

System::SharedPtr<Aspose::Words::Font> Aspose::Words::Markup::StructuredDocumentTag::get_ContentsFont ( )

Font formatting that will be applied to text entered into SDT.

◆ get_DateDisplayFormat()

System::String Aspose::Words::Markup::StructuredDocumentTag::get_DateDisplayFormat ( )

String that represents the format in which dates are displayed. Can not be null.

Accessing this property will only work for Aspose::Words::Markup::SdtType::Date SDT type.

For all other SDT types exception will occur.

◆ get_DateDisplayLocale()

int32_t Aspose::Words::Markup::StructuredDocumentTag::get_DateDisplayLocale ( )

Allows to set/get the language format for the date displayed in this SDT.

Accessing this property will only work for Aspose::Words::Markup::SdtType::Date SDT type.

For all other SDT types exception will occur.

◆ get_DateStorageFormat()

Aspose::Words::Markup::SdtDateStorageFormat Aspose::Words::Markup::StructuredDocumentTag::get_DateStorageFormat ( )

Gets/sets format in which the date for a date SDT is stored when the SDT is bound to an XML node in the document's data store. Default value is Aspose::Words::Markup::SdtDateStorageFormat::DateTime

Accessing this property will only work for Aspose::Words::Markup::SdtType::Date SDT type.

For all other SDT types exception will occur.

◆ get_DeleteRevision()

System::SharedPtr<Aspose::Words::Revisions::EditRevision> Aspose::Words::Markup::StructuredDocumentTag::get_DeleteRevision ( )

◆ get_EndCharacterFont()

System::SharedPtr<Aspose::Words::Font> Aspose::Words::Markup::StructuredDocumentTag::get_EndCharacterFont ( )

Font formatting that will be applied to the last character of text entered into SDT.

◆ get_FullDate()

System::DateTime Aspose::Words::Markup::StructuredDocumentTag::get_FullDate ( )

Specifies the full date and time last entered into this SDT.

Accessing this property will only work for Aspose::Words::Markup::SdtType::Date SDT type.

For all other SDT types exception will occur.

◆ get_Id()

int32_t Aspose::Words::Markup::StructuredDocumentTag::get_Id ( )

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

Id attribute shall follow these rules:

  • The document shall retain SDT ids only if the whole document is cloned Aspose::Words::Document::Clone.
  • During Aspose::Words::DocumentBase::ImportNode(System::SharedPtr<Aspose::Words::Node>, bool) Id shall be retained if import does not cause conflicts with other SDT Ids in the target document.
  • If multiple SDT nodes specify the same decimal number value for the Id attribute, then the first SDT in the document shall maintain this original Id, and all subsequent SDT nodes shall have new identifiers assigned to them when the document is loaded.
  • During standalone SDT Aspose::Words::Markup::StructuredDocumentTag::Clone(bool, System::SharedPtr<Aspose::Words::INodeCloningListener>) operation new unique ID will be generated for the cloned SDT node.
  • If Id is not specified in the source document, then the SDT node shall have a new unique identifier assigned to it when the document is loaded.

◆ get_InsertRevision()

System::SharedPtr<Aspose::Words::Revisions::EditRevision> Aspose::Words::Markup::StructuredDocumentTag::get_InsertRevision ( )

◆ get_IsShowingPlaceholderText()

bool Aspose::Words::Markup::StructuredDocumentTag::get_IsShowingPlaceholderText ( ) const

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.

◆ get_IsTemporary()

bool Aspose::Words::Markup::StructuredDocumentTag::get_IsTemporary ( ) const

Specifies whether this SDT shall be removed from the WordprocessingML document when its contents are modified.

◆ get_Level()

Aspose::Words::Markup::MarkupLevel Aspose::Words::Markup::StructuredDocumentTag::get_Level ( ) const

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

◆ get_Level_IMarkupNode()

Aspose::Words::Markup::MarkupLevel Aspose::Words::Markup::StructuredDocumentTag::get_Level_IMarkupNode ( )

◆ get_ListItems()

System::SharedPtr<Aspose::Words::Markup::SdtListItemCollection> Aspose::Words::Markup::StructuredDocumentTag::get_ListItems ( )

Gets Aspose::Words::Markup::SdtListItemCollection associated with this SDT.

Accessing this property will only work for Aspose::Words::Markup::SdtType::ComboBox or Aspose::Words::Markup::SdtType::DropDownList SDT types.

For all other SDT types exception will occur.

◆ get_LockContentControl()

bool Aspose::Words::Markup::StructuredDocumentTag::get_LockContentControl ( ) const

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

◆ get_LockContents()

bool Aspose::Words::Markup::StructuredDocumentTag::get_LockContents ( ) const

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

◆ get_MoveFromRevision()

System::SharedPtr<Aspose::Words::Revisions::MoveRevision> Aspose::Words::Markup::StructuredDocumentTag::get_MoveFromRevision ( )

◆ get_MoveToRevision()

System::SharedPtr<Aspose::Words::Revisions::MoveRevision> Aspose::Words::Markup::StructuredDocumentTag::get_MoveToRevision ( )

◆ get_Multiline()

bool Aspose::Words::Markup::StructuredDocumentTag::get_Multiline ( )

Specifies whether this SDT allows multiple lines of text.

Accessing this property will only work for Aspose::Words::Markup::SdtType::RichText and Aspose::Words::Markup::SdtType::PlainText SDT type.

For all other SDT types exception will occur.

◆ get_NodeType()

virtual Aspose::Words::NodeType Aspose::Words::Markup::StructuredDocumentTag::get_NodeType ( ) const
virtual

◆ get_Placeholder()

System::SharedPtr<Aspose::Words::BuildingBlocks::BuildingBlock> Aspose::Words::Markup::StructuredDocumentTag::get_Placeholder ( ) const

Gets the Aspose::Words::BuildingBlocks::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 Aspose::Words::Markup::StructuredDocumentTag::get_XmlMapping element or the Aspose::Words::Markup::StructuredDocumentTag::get_IsShowingPlaceholderText element is true.

Can be null, meaning that the placeholder is not applicable for this Sdt.

◆ get_PlaceholderName()

System::String Aspose::Words::Markup::StructuredDocumentTag::get_PlaceholderName ( ) const

Gets or sets Name of the Aspose::Words::BuildingBlocks::BuildingBlock containing placeholder text.

BuildingBlock with this name Aspose::Words::BuildingBlocks::BuildingBlock::get_Name has to be present in the Aspose::Words::Document::get_GlossaryDocument otherwise System::InvalidOperationException will occur.

◆ get_SdtType()

Aspose::Words::Markup::SdtType Aspose::Words::Markup::StructuredDocumentTag::get_SdtType ( )

Gets type of this Structured document tag.

◆ get_Style()

System::SharedPtr<Aspose::Words::Style> Aspose::Words::Markup::StructuredDocumentTag::get_Style ( )

Gets or sets the Style of the structured document tag.

Only Aspose::Words::StyleType::Character style or Aspose::Words::StyleType::Paragraph style with linked character style can be set.

◆ get_StyleName()

System::String Aspose::Words::Markup::StructuredDocumentTag::get_StyleName ( )

Gets or sets the name of the style applied to the structured document tag.

◆ get_Tag()

System::String Aspose::Words::Markup::StructuredDocumentTag::get_Tag ( ) const

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

A tag is an arbitrary string which applications can associate with SDT in order to identify it without providing a visible friendly name.

◆ get_Title()

System::String Aspose::Words::Markup::StructuredDocumentTag::get_Title ( ) const

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

◆ get_XmlMapping()

System::SharedPtr<Aspose::Words::Markup::XmlMapping> Aspose::Words::Markup::StructuredDocumentTag::get_XmlMapping ( ) const

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

You can use the Aspose::Words::Markup::XmlMapping::SetMapping(System::SharedPtr<Aspose::Words::Markup::CustomXmlPart>, System::String, System::String) method of this object to map a structured document tag to XML data.

◆ GetDirectRunAttr()

System::SharedPtr<System::Object> Aspose::Words::Markup::StructuredDocumentTag::GetDirectRunAttr ( int32_t  key)

◆ RemoveRunAttr()

void Aspose::Words::Markup::StructuredDocumentTag::RemoveRunAttr ( int32_t  key)

◆ RemoveSelfOnly()

void Aspose::Words::Markup::StructuredDocumentTag::RemoveSelfOnly ( )

Removes just this SDT node itself, but keeps the content of it inside the document tree.

◆ set_BuildingBlockCategory()

void Aspose::Words::Markup::StructuredDocumentTag::set_BuildingBlockCategory ( System::String  value)

◆ set_BuildingBlockGallery()

void Aspose::Words::Markup::StructuredDocumentTag::set_BuildingBlockGallery ( System::String  value)

◆ set_CalendarType()

void Aspose::Words::Markup::StructuredDocumentTag::set_CalendarType ( Aspose::Words::Markup::SdtCalendarType  value)

◆ set_Checked()

void Aspose::Words::Markup::StructuredDocumentTag::set_Checked ( bool  value)

◆ set_Color()

void Aspose::Words::Markup::StructuredDocumentTag::set_Color ( System::Drawing::Color  value)

◆ set_DateDisplayFormat()

void Aspose::Words::Markup::StructuredDocumentTag::set_DateDisplayFormat ( System::String  value)

◆ set_DateDisplayLocale()

void Aspose::Words::Markup::StructuredDocumentTag::set_DateDisplayLocale ( int32_t  value)

◆ set_DateStorageFormat()

void Aspose::Words::Markup::StructuredDocumentTag::set_DateStorageFormat ( Aspose::Words::Markup::SdtDateStorageFormat  value)

◆ set_DeleteRevision()

void Aspose::Words::Markup::StructuredDocumentTag::set_DeleteRevision ( System::SharedPtr< Aspose::Words::Revisions::EditRevision >  value)

◆ set_FullDate()

void Aspose::Words::Markup::StructuredDocumentTag::set_FullDate ( System::DateTime  value)

◆ set_InsertRevision()

void Aspose::Words::Markup::StructuredDocumentTag::set_InsertRevision ( System::SharedPtr< Aspose::Words::Revisions::EditRevision >  value)

◆ set_IsShowingPlaceholderText()

void Aspose::Words::Markup::StructuredDocumentTag::set_IsShowingPlaceholderText ( bool  value)

◆ set_IsTemporary()

void Aspose::Words::Markup::StructuredDocumentTag::set_IsTemporary ( bool  value)

◆ set_LockContentControl()

void Aspose::Words::Markup::StructuredDocumentTag::set_LockContentControl ( bool  value)

◆ set_LockContents()

void Aspose::Words::Markup::StructuredDocumentTag::set_LockContents ( bool  value)

◆ set_MoveFromRevision()

void Aspose::Words::Markup::StructuredDocumentTag::set_MoveFromRevision ( System::SharedPtr< Aspose::Words::Revisions::MoveRevision >  value)

◆ set_MoveToRevision()

void Aspose::Words::Markup::StructuredDocumentTag::set_MoveToRevision ( System::SharedPtr< Aspose::Words::Revisions::MoveRevision >  value)

◆ set_Multiline()

void Aspose::Words::Markup::StructuredDocumentTag::set_Multiline ( bool  value)

◆ set_PlaceholderName()

void Aspose::Words::Markup::StructuredDocumentTag::set_PlaceholderName ( System::String  value)

◆ set_Style()

void Aspose::Words::Markup::StructuredDocumentTag::set_Style ( System::SharedPtr< Aspose::Words::Style value)

◆ set_StyleName()

void Aspose::Words::Markup::StructuredDocumentTag::set_StyleName ( System::String  value)

◆ set_Tag()

void Aspose::Words::Markup::StructuredDocumentTag::set_Tag ( System::String  value)

◆ set_Title()

void Aspose::Words::Markup::StructuredDocumentTag::set_Title ( System::String  value)

◆ SetRunAttr()

void Aspose::Words::Markup::StructuredDocumentTag::SetRunAttr ( int32_t  key,
System::SharedPtr< System::Object value 
)