com.aspose.words

Class SmartTag

java.lang.Object

com.aspose.words.Node

com.aspose.words.CompositeNode

com.aspose.words.SmartTag

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Iterable

public class SmartTag
extends CompositeNode

This element specifies the presence of a smart tag around one or more inline structures (runs, images, fields,etc.) within a paragraph.

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

Smart tags is a kind of custom XML markup. Smart tags provide a facility for embedding customer-defined semantics into the document via the ability to provide a basic namespace/name for a run or set of runs within a document.

SmartTag can be a child of a Paragraph or another SmartTag node.

The complete list of child nodes that can occur inside a smart tag consists of BookmarkStart, BookmarkEnd, FieldStart, FieldSeparator, FieldEnd, FormField, Comment, Footnote, Run, SpecialChar, Shape, GroupShape, CommentRangeStart, CommentRangeEnd, SmartTag.

Constructor Summary

Constructors

Constructor and Description
SmartTag(DocumentBase doc) Initializes a new instance of the SmartTag class.

Method Summary

Modifier and Type	Method and Description
boolean	accept(DocumentVisitor visitor) Accepts a visitor.
java.lang.String	getElement() Specifies the name of the smart tag within the document.
int	getLevel_IMarkupNode()
int	getNodeType() Returns NodeType.SmartTag.
CustomXmlPropertyCollection	getProperties() A collection of the smart tag properties.
java.lang.String	getUri() Specifies the namespace URI of the smart tag.
void	setElement(java.lang.String value) Specifies the name of the smart tag within the document.
void	setUri(java.lang.String value) Specifies the namespace URI of the smart tag.

Methods inherited from class com.aspose.words.CompositeNode

acceptChildren, acceptCore, appendChild, coreRemoveSelfOnly, getChild, getChildNodes, getChildNodes, getContainer, getCount, getCurrentNode, getFirstChild, getLastChild, getNextMatchingNode, getText, hasChildNodes, indexOf, insertAfter, insertBefore, isComposite, iterator, prependChild, removeAllChildren, removeChild, removeSmartTags, selectNodes, selectSingleNode

Methods inherited from class com.aspose.words.Node

dd, deepClone, getAncestor, getAncestor, getCustomNodeId, getDocument, getNextSibling, getParentNode, getPreviousSibling, getRange, 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

SmartTag

public SmartTag(DocumentBase doc)

Initializes a new instance of the SmartTag class.

When you create a new node, you need to specify a document to which the node belongs. A node cannot exist without a document because it depends on the document-wide structures such as lists and styles. Although a node always belongs to a document, a node might or might not be a part of the document tree.

When a node is created, it belongs to a document, but is not yet part of the document tree and Node.getParentNode() is null. To insert a node into the document, use the CompositeNode.insertAfter(com.aspose.words.Node, com.aspose.words.Node) or CompositeNode.insertBefore(com.aspose.words.Node, com.aspose.words.Node) methods on the parent node.

Parameters:

doc - The owner document.

Method Detail

getNodeType

public int getNodeType()

Returns NodeType.SmartTag.

Specified by:

getNodeType in class Node

Returns:

NodeType.SmartTag. The returned value is one of NodeType constants.

accept

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

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

getElement

public java.lang.String getElement()

Specifies the name of the smart tag within the document.

Cannot be null.

Default is empty string.

Returns:

The corresponding String value.

setElement

public void setElement(java.lang.String value)

Specifies the name of the smart tag within the document.

Cannot be null.

Default is empty string.

Parameters:

value - The corresponding String value.

getUri

public java.lang.String getUri()

Specifies the namespace URI of the smart tag.

Cannot be null.

Default is empty string.

Returns:

The corresponding String value.

setUri

public void setUri(java.lang.String value)

Specifies the namespace URI of the smart tag.

Cannot be null.

Default is empty string.

Parameters:

value - The corresponding String value.

getProperties

public CustomXmlPropertyCollection getProperties()

A collection of the smart tag properties.

Cannot be null.

Returns:

The corresponding CustomXmlPropertyCollection value.

getLevel_IMarkupNode

public int getLevel_IMarkupNode()