StructuredDocumentTag

StructuredDocumentTag

Overview

StructuredDocumentTag is a class in Aspose.Words FOSS for Java. Inherits from: CompositeNode<Node>, IMarkupNode, ITrackableNode, and 2 more.

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

Edition status of its 93 listed members (a property and its accessor methods are listed separately, overloads once): 93 not yet exercised by a verified example.

This class declares 62 methods for StructuredDocumentTag objects in Java programs. Available methods include: StructuredDocumentTag, accept, acceptEnd, acceptStart, clear, getAppearance, getBuildingBlockCategory, getBuildingBlockGallery, getCalendarType, getChecked, getChildNodes, getColor, and 48 additional methods. Public members are accessible to any Java application after installing the Aspose.Words FOSS for Java package. Properties: appearance, buildingBlockCategory, buildingBlockGallery, calendarType, checked, color, and 27 more.

Properties

NameTypeAccessDescription
nodeTypeintReadReturns StructuredDocumentTag.
placeholderBuildingBlockReadGets 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.
placeholderNameStringRead/WriteGets or sets Name of the BuildingBlock containing placeholder text.
levelintReadGets the level at which this SDT occurs in the document tree.
sdtTypeintReadGets type of this Structured document tag.
idintReadSpecifies a unique read-only persistent numerical Id for this SDT.
lockContentControlbooleanRead/WriteWhen set to true, this property will prohibit a user from deleting this SDT.
lockContentsbooleanRead/WriteWhen set to true, this property will prohibit a user from editing the contents of this SDT.
showingPlaceholderTextbooleanRead/WriteSpecifies whether the content of this SDT shall be interpreted to contain placeholder text (as opposed to regular text contents within the SDT).
tagStringRead/WriteSpecifies a tag associated with the current SDT node.
contentsFontFontReadFont formatting that will be applied to text entered into SDT.
endCharacterFontFontReadFont formatting that will be applied to the last character of text entered into SDT.
temporarybooleanRead/WriteSpecifies whether this SDT shall be removed from the WordProcessingML document when its contents are modified.
titleStringRead/WriteSpecifies the friendly name associated with this SDT.
listItemsSdtListItemCollectionReadGets SdtListItemCollection associated with this SDT.
checkedbooleanRead/WriteGets/Sets current state of the Checkbox SDT.
appearanceintRead/WriteGets/sets the appearance of a structured document tag.
dateDisplayLocaleintRead/WriteAllows to set/get the language format for the date displayed in this SDT.
dateDisplayFormatStringRead/WriteString that represents the format in which dates are displayed.
fullDatejava.util.DateRead/WriteGets or sets the full date.
dateStorageFormatintRead/WriteGets/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.
calendarTypeintRead/WriteSpecifies the type of calendar for this SDT.
buildingBlockGalleryStringRead/WriteSpecifies type of building block for this SDT.
buildingBlockCategoryStringRead/WriteSpecifies category of building block for this SDT node.
multilinebooleanRead/WriteSpecifies whether this SDT allows multiple lines of text.
colorColorRead/WriteGets or sets the color of the structured document tag.
styleStyleRead/WriteGets or sets the Style of the structured document tag.
styleNameStringRead/WriteGets or sets the name of the style applied to the structured document tag.
xmlMappingXmlMappingReadGets an object that represents the mapping of this structured document tag to XML data in a custom XML part of the current document.
wordOpenXMLStringReadGets a string that represents the XML contained within the node in the SaveFormat.FLAT_OPC format.
wordOpenXMLMinimalStringReadGets a string that represents the XML contained within the node in the SaveFormat.FLAT_OPC format.
multiSectionbooleanReadReturns true if this instance is a ranged (multi-section) structured document tag.
nodeNodeReadReturns Node object that implements this interface.

Methods

SignatureDescription
StructuredDocumentTag(doc: DocumentBase, type: int, level: int)Initializes a new instance of the Structured document tag class.
setCheckedSymbol(characterCode: int, fontName: String)Sets the symbol used to represent the checked state of a check box content control.
setUncheckedSymbol(characterCode: int, fontName: String)Sets the symbol used to represent the unchecked state of a check box content control.
removeSelfOnly()Removes just this SDT node itself, but keeps the content of it inside the document tree.
accept(visitor: DocumentVisitor) → booleanCalls accept(visitor) on this StructuredDocumentTag instance.
clear()Clears contents of this structured document tag and displays a placeholder if it is defined.
acceptStart(visitor: DocumentVisitor) → intAccepts a visitor for visiting the start of the StructuredDocumentTag.
acceptEnd(visitor: DocumentVisitor) → intAccepts a visitor for visiting the end of the StructuredDocumentTag.
getNodeType() → intReturns StructuredDocumentTag.
getPlaceholder() → BuildingBlockGets 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.
getPlaceholderName() → StringGets or sets Name of the BuildingBlock containing placeholder text.
setPlaceholderName(value: String)Sets the placeholder name value.
getLevel() → intGets the level at which this SDT occurs in the document tree.
getSdtType() → intGets type of this Structured document tag.
getId() → intSpecifies a unique read-only persistent numerical Id for this SDT.
getLockContentControl() → booleanWhen set to true, this property will prohibit a user from deleting this SDT.
setLockContentControl(value: boolean)Sets the lock content control value.
getLockContents() → booleanWhen set to true, this property will prohibit a user from editing the contents of this SDT.
setLockContents(value: boolean)Sets the lock contents value.
isShowingPlaceholderText() → booleanSpecifies whether the content of this SDT shall be interpreted to contain placeholder text (as opposed to regular text contents within the SDT).
isShowingPlaceholderText(value: boolean)Calls isShowingPlaceholderText(value) on this StructuredDocumentTag instance.
getTag() → StringSpecifies a tag associated with the current SDT node.
setTag(value: String)Sets the tag value.
getContentsFont() → FontFont formatting that will be applied to text entered into SDT.
getEndCharacterFont() → FontFont formatting that will be applied to the last character of text entered into SDT.
isTemporary() → booleanSpecifies whether this SDT shall be removed from the WordProcessingML document when its contents are modified.
isTemporary(value: boolean)Calls isTemporary(value) on this StructuredDocumentTag instance.
getTitle() → StringSpecifies the friendly name associated with this SDT.
setTitle(value: String)Sets the title value.
getListItems() → SdtListItemCollectionGets SdtListItemCollection associated with this SDT.
getChecked() → booleanGets/Sets current state of the Checkbox SDT.
setChecked(value: boolean)Sets the checked value.
getAppearance() → intGets/sets the appearance of a structured document tag.
setAppearance(value: int)Sets the appearance value.
getDateDisplayLocale() → intAllows to set/get the language format for the date displayed in this SDT.
setDateDisplayLocale(value: int)Sets the date display locale value.
getDateDisplayFormat() → StringString that represents the format in which dates are displayed.
setDateDisplayFormat(value: String)Sets the date display format value.
getFullDate() → java.util.DateReturns the full date.
setFullDate(value: java.util.Date)Sets the full date value.
getDateStorageFormat() → intGets/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.
setDateStorageFormat(value: int)Sets the date storage format value.
getCalendarType() → intSpecifies the type of calendar for this SDT.
setCalendarType(value: int)Sets the calendar type value.
getBuildingBlockGallery() → StringSpecifies type of building block for this SDT.
setBuildingBlockGallery(value: String)Sets the building block gallery value.
getBuildingBlockCategory() → StringSpecifies category of building block for this SDT node.
setBuildingBlockCategory(value: String)Sets the building block category value.
getMultiline() → booleanSpecifies whether this SDT allows multiple lines of text.
setMultiline(value: boolean)Sets the multiline value.
getColor() → ColorGets or sets the color of the structured document tag.
setColor(value: Color)Sets the color value.
getStyle() → StyleGets or sets the Style of the structured document tag.
setStyle(value: Style)Sets the style value.
getStyleName() → StringGets or sets the name of the style applied to the structured document tag.
setStyleName(value: String)Sets the style name value.
getXmlMapping() → XmlMappingGets an object that represents the mapping of this structured document tag to XML data in a custom XML part of the current document.
getWordOpenXML() → StringGets a string that represents the XML contained within the node in the SaveFormat.FLAT_OPC format.
getWordOpenXMLMinimal() → StringGets a string that represents the XML contained within the node in the SaveFormat.FLAT_OPC format.
getChildNodes(nodeType: int, isDeep: boolean) → NodeCollectionReturns a live collection of child nodes that match the specified types.
isMultiSection() → booleanReturns true if this instance is a ranged (multi-section) structured document tag.
getNode() → NodeReturns Node object that implements this interface.

See Also