com.aspose.words

Class StructuredDocumentTagRangeStart

java.lang.Object

com.aspose.words.Node

com.aspose.words.StructuredDocumentTagRangeStart

All Implemented Interfaces:

IStructuredDocumentTag, java.lang.Cloneable, java.lang.Iterable

public class StructuredDocumentTagRangeStart
extends Node
implements IStructuredDocumentTag, java.lang.Iterable

Represents a start of ranged structured document tag which accepts multi-sections content. See also StructuredDocumentTagRangeEnd.

To learn more, visit the Structured Document Tags or Content Control documentation article.

Can be immediate child of Body node only.

Constructor Summary

Constructors

Constructor and Description
StructuredDocumentTagRangeStart(DocumentBase doc, int type) Initializes a new instance of this class.

Method Summary

Modifier and Type	Method and Description
boolean	accept(DocumentVisitor visitor) Accepts a visitor.
Node	appendChild(Node newChild) Adds the specified node to the end of the stdContent range.
NodeCollection	getChildNodes() Gets all nodes between this range start node and the range end node.
NodeCollection	getChildNodes(int nodeType, boolean isDeep)
java.awt.Color	getColor() Gets the color of the structured document tag.
int	getId() Specifies a unique read-only persistent numerical Id for this structured document tag.
Node	getLastChild() Gets the last child in the stdContent range.
int	getLevel() Gets the level at which this structured document tag range start occurs in the document tree.
boolean	getLockContentControl() When set to true, this property will prohibit a user from deleting this structured document tag.
boolean	getLockContents() When set to true, this property will prohibit a user from editing the contents of this structured document tag.
int	getNodeType() Gets the type of this node.
BuildingBlock	getPlaceholder() Gets the BuildingBlock containing placeholder text which should be displayed when this structured document tag run contents are empty, the associated mapped XML element is empty as specified via the getXmlMapping() element or the isShowingPlaceholderText() / isShowingPlaceholderText(boolean) element is true.
java.lang.String	getPlaceholderName() Gets or sets Name of the BuildingBlock containing placeholder text.
StructuredDocumentTagRangeEnd	getRangeEnd() Specifies end of range if the StructuredDocumentTag is a ranged structured document tag.
int	getSdtType() Gets type of this structured document tag.
java.lang.String	getTag() Specifies a tag associated with the current structured document tag node.
java.lang.String	getTitle() Specifies the friendly name associated with this structured document tag.
java.lang.String	getWordOpenXML() Gets a string that represents the XML contained within the node in the SaveFormat.FLAT_OPC format.
XmlMapping	getXmlMapping() Gets an object that represents the mapping of this structured document tag range to XML data in a custom XML part of the current document.
boolean	isRanged() Returns true if this instance is a ranged structured document tag.
boolean	isShowingPlaceholderText() Specifies whether the content of this structured document tag shall be interpreted to contain placeholder text (as opposed to regular text contents within the structured document tag).
void	isShowingPlaceholderText(boolean value) Specifies whether the content of this structured document tag shall be interpreted to contain placeholder text (as opposed to regular text contents within the structured document tag).
java.util.Iterator	iterator() Provides support for the for each style iteration over the child nodes of this node.
void	removeAllChildren() Removes all the nodes between this range start node and the range end node.
void	removeSelfOnly() Removes this range start and appropriate range end nodes of the structured document tag, but keeps its content inside the document tree.
void	setColor(java.awt.Color value) Sets the color of the structured document tag.
void	setLockContentControl(boolean value) When set to true, this property will prohibit a user from deleting this structured document tag.
void	setLockContents(boolean value) When set to true, this property will prohibit a user from editing the contents of this structured document tag.
void	setPlaceholderName(java.lang.String value) Gets or sets Name of the BuildingBlock containing placeholder text.
void	setTag(java.lang.String value) Specifies a tag associated with the current structured document tag node.
void	setTitle(java.lang.String value) Specifies the friendly name associated with this structured document tag.
Node	structuredDocumentTagNode() Returns Node object that implements this interface.

Methods inherited from class com.aspose.words.Node

dd, deepClone, getAncestor, getAncestor, getCustomNodeId, getDocument, getNextSibling, getParentNode, getPreviousSibling, getRange, getText, isComposite, memberwiseClone, nextPreOrder, nodeTypeToString, previousPreOrder, remove, setCustomNodeId, toString, toString, toString, visitorActionToBool

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

StructuredDocumentTagRangeStart

public StructuredDocumentTagRangeStart(DocumentBase doc,
                                       int type)

Initializes a new instance of this class.

Method Detail

getChildNodes

public NodeCollection getChildNodes(int nodeType,
                                    boolean isDeep)

isRanged

public boolean isRanged()

Description copied from interface: IStructuredDocumentTag

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

Specified by:

isRanged in interface IStructuredDocumentTag

structuredDocumentTagNode

public Node structuredDocumentTagNode()

Description copied from interface: IStructuredDocumentTag

Returns Node object that implements this interface.

Specified by:

structuredDocumentTagNode in interface IStructuredDocumentTag

getNodeType

public int getNodeType()

Description copied from class: Node

Gets the type of this node.

Specified by:

getNodeType in class Node

Returns:

The type of this node. The returned value is one of NodeType constants.

getChildNodes

public NodeCollection getChildNodes()

Gets all nodes between this range start node and the range end node.

Returns:

All nodes between this range start node and the range end node.

getLastChild

public Node getLastChild()

Gets the last child in the stdContent range. If there is no last child node, a null is returned.

Returns:

The last child in the stdContent range.

getLevel

public int getLevel()

Gets the level at which this structured document tag range start occurs in the document tree.

Specified by:

getLevel in interface IStructuredDocumentTag

Returns:

The level at which this structured document tag range start occurs in the document tree. The returned value is one of MarkupLevel constants.

getSdtType

public int getSdtType()

Gets type of this structured document tag.

Specified by:

getSdtType in interface IStructuredDocumentTag

Returns:

Type of this structured document tag. The returned value is one of SdtType constants.

getColor

public java.awt.Color getColor()

Gets the color of the structured document tag.

Specified by:

getColor in interface IStructuredDocumentTag

Returns:

The color of the structured document tag.

setColor

public void setColor(java.awt.Color value)

Sets the color of the structured document tag.

Specified by:

setColor in interface IStructuredDocumentTag

Parameters:

value - The color of the structured document tag.

getId

public int getId()

Specifies a unique read-only persistent numerical Id for this structured document tag.

Id attribute shall follow these rules:

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

Specified by:

getId in interface IStructuredDocumentTag

Returns:

The corresponding int value.

getLockContentControl

public boolean getLockContentControl()

When set to true, this property will prohibit a user from deleting this structured document tag.

Specified by:

getLockContentControl in interface IStructuredDocumentTag

Returns:

The corresponding boolean value.

setLockContentControl

public void setLockContentControl(boolean value)

When set to true, this property will prohibit a user from deleting this structured document tag.

Specified by:

setLockContentControl in interface IStructuredDocumentTag

Parameters:

value - The corresponding boolean value.

getLockContents

public boolean getLockContents()

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

Specified by:

getLockContents in interface IStructuredDocumentTag

Returns:

The corresponding boolean value.

setLockContents

public void setLockContents(boolean value)

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

Specified by:

setLockContents in interface IStructuredDocumentTag

Parameters:

value - The corresponding boolean value.

isShowingPlaceholderText

public boolean isShowingPlaceholderText()

Specifies whether the content of this structured document tag shall be interpreted to contain placeholder text (as opposed to regular text contents within the structured document tag).

if set to true, this state shall be resumed (showing placeholder text) upon opening this document.

Specified by:

isShowingPlaceholderText in interface IStructuredDocumentTag

Returns:

The corresponding boolean value.

isShowingPlaceholderText

public void isShowingPlaceholderText(boolean value)

Specifies whether the content of this structured document tag shall be interpreted to contain placeholder text (as opposed to regular text contents within the structured document tag).

if set to true, this state shall be resumed (showing placeholder text) upon opening this document.

Specified by:

isShowingPlaceholderText in interface IStructuredDocumentTag

Parameters:

value - The corresponding boolean value.

getPlaceholder

public BuildingBlock getPlaceholder()

Gets the BuildingBlock containing placeholder text which should be displayed when this structured document tag run contents are empty, the associated mapped XML element is empty as specified via the getXmlMapping() element or the isShowingPlaceholderText() / isShowingPlaceholderText(boolean) element is true. Can be null, meaning that the placeholder is not applicable for this structured document tag.

Specified by:

getPlaceholder in interface IStructuredDocumentTag

Returns:

The BuildingBlock containing placeholder text which should be displayed when this structured document tag run contents are empty, the associated mapped XML element is empty as specified via the getXmlMapping() element or the isShowingPlaceholderText() / isShowingPlaceholderText(boolean) element is true.

getPlaceholderName

public java.lang.String getPlaceholderName()

Gets or sets Name of the BuildingBlock containing placeholder text.

BuildingBlock with this name BuildingBlock.getName() / BuildingBlock.setName(java.lang.String) has to be present in the Document.getGlossaryDocument() / Document.setGlossaryDocument(com.aspose.words.GlossaryDocument) otherwise IllegalStateException will occur.

Specified by:

getPlaceholderName in interface IStructuredDocumentTag

Returns:

The corresponding String value.

setPlaceholderName

public void setPlaceholderName(java.lang.String value)

Gets or sets Name of the BuildingBlock containing placeholder text.

BuildingBlock with this name BuildingBlock.getName() / BuildingBlock.setName(java.lang.String) has to be present in the Document.getGlossaryDocument() / Document.setGlossaryDocument(com.aspose.words.GlossaryDocument) otherwise IllegalStateException will occur.

Specified by:

setPlaceholderName in interface IStructuredDocumentTag

Parameters:

value - The corresponding String value.

getTag

public java.lang.String getTag()

Specifies a tag associated with the current structured document tag node. Can not be null. A tag is an arbitrary string which applications can associate with structured document tag in order to identify it without providing a visible friendly name.

Specified by:

getTag in interface IStructuredDocumentTag

Returns:

The corresponding String value.

setTag

public void setTag(java.lang.String value)

Specifies a tag associated with the current structured document tag node. Can not be null. A tag is an arbitrary string which applications can associate with structured document tag in order to identify it without providing a visible friendly name.

Specified by:

setTag in interface IStructuredDocumentTag

Parameters:

value - The corresponding String value.

getTitle

public java.lang.String getTitle()

Specifies the friendly name associated with this structured document tag. Can not be null.

Specified by:

getTitle in interface IStructuredDocumentTag

Returns:

The corresponding String value.

setTitle

public void setTitle(java.lang.String value)

Specifies the friendly name associated with this structured document tag. Can not be null.

Specified by:

setTitle in interface IStructuredDocumentTag

Parameters:

value - The corresponding String value.

getWordOpenXML

public java.lang.String getWordOpenXML()
                                throws java.lang.Exception

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

Specified by:

getWordOpenXML in interface IStructuredDocumentTag

Returns:

A string that represents the XML contained within the node in the SaveFormat.FLAT_OPC format.

Throws:

java.lang.Exception

getXmlMapping

public XmlMapping getXmlMapping()

Gets an object that represents the mapping of this structured document tag range to XML data in a custom XML part of the current document. You can use the XmlMapping.setMapping(com.aspose.words.CustomXmlPart, java.lang.String, java.lang.String) method of this object to map a structured document tag range to XML data.

Specified by:

getXmlMapping in interface IStructuredDocumentTag

Returns:

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

accept

public boolean accept(DocumentVisitor visitor)
               throws java.lang.Exception

Description copied from class: Node

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.

Specified by:

accept in class Node

Parameters:

visitor - The visitor that will visit the nodes.

Returns:

True if all nodes were visited; false if DocumentVisitor stopped the operation before visiting all nodes.

Throws:

java.lang.Exception

getRangeEnd

public StructuredDocumentTagRangeEnd getRangeEnd()

Specifies end of range if the StructuredDocumentTag is a ranged structured document tag. Otherwise returns null.

Returns:

The corresponding StructuredDocumentTagRangeEnd value.

iterator

public java.util.Iterator iterator()

Provides support for the for each style iteration over the child nodes of this node.

Specified by:

iterator in interface java.lang.Iterable

appendChild

public Node appendChild(Node newChild)

Adds the specified node to the end of the stdContent range.

Parameters:

newChild - The node to add.

Returns:

The node added.

removeAllChildren

public void removeAllChildren()

Removes all the nodes between this range start node and the range end node.

removeSelfOnly

public void removeSelfOnly()

Removes this range start and appropriate range end nodes of the structured document tag, but keeps its content inside the document tree.