com.aspose.words
Class SmartTag

com.aspose.words.CompositeNode
    extended by com.aspose.words.SmartTag

public class SmartTag 
extends com.aspose.words.CompositeNode

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

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 Aspose.Words.Paragraph or another SmartTag node.

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


Property Getters/Setters Summary
Aspose.Words.NodeCollectiongetChildNodes()→ inherited from Aspose.Words.CompositeNode
           Gets all immediate child nodes of this node.
intgetCount()→ inherited from Aspose.Words.CompositeNode
           Gets the number of immediate children of this node.
Aspose.Words.DocumentBasegetDocument()→ inherited from Aspose.Words.Node
           Gets the document to which this node belongs.
java.lang.StringgetElement()
voidsetElement(java.lang.String value)
           Specifies the name of the smart tag within the document.
Aspose.Words.NodegetFirstChild()→ inherited from Aspose.Words.CompositeNode
           Gets the first child of the node.
booleanhasChildNodes()→ inherited from Aspose.Words.CompositeNode
           Returns true if this node has any child nodes.
booleanisComposite()→ inherited from Aspose.Words.CompositeNode
           Returns true as this node can have child nodes.
Aspose.Words.NodegetLastChild()→ inherited from Aspose.Words.CompositeNode
           Gets the last child of the node.
Aspose.Words.NodegetNextSibling()→ inherited from Aspose.Words.Node
           Gets the node immediately following this node.
Aspose.Words.NodeTypegetNodeType()
           Returns NodeType.SmartTag.
Aspose.Words.CompositeNodegetParentNode()→ inherited from Aspose.Words.Node
           Gets the immediate parent of this node.
Aspose.Words.NodegetPreviousSibling()→ inherited from Aspose.Words.Node
           Gets the node immediately preceding this node.
CustomXmlPropertyCollectiongetProperties()
           A collection of the smart tag properties.
Aspose.Words.RangegetRange()→ inherited from Aspose.Words.Node
           Returns a Range object that represents the portion of a document that is contained in this node.
java.lang.StringgetUri()
voidsetUri(java.lang.String value)
           Specifies the namespace URI of the smart tag.
 
Method Summary
voiddd()→ inherited from Aspose.Words.CompositeNode
          
Aspose.Words.NodedeepClone(boolean isCloneChildren)→ inherited from Aspose.Words.Node
           Creates a duplicate of the node.
Aspose.Words.CompositeNodegetAncestor(java.lang.Class ancestorType)→ inherited from Aspose.Words.Node
           Gets the first ancestor of the specified object type.
Aspose.Words.CompositeNodegetContainer()→ inherited from Aspose.Words.CompositeNode
          Reserved for internal use.
intgetLevel_IMarkupNode()
          Reserved for internal use.
Aspose.Words.NodegetNextMatchingNode(aspose.obfuscated.type curNode)→ inherited from Aspose.Words.CompositeNode
          Reserved for internal use.
java.lang.StringgetText()→ inherited from Aspose.Words.CompositeNode
           Gets the text of this node and of all its children.
java.util.Iteratoriterator()→ inherited from Aspose.Words.CompositeNode
           Provides support for the for each style iteration over the child nodes of this node.
voidremove()→ inherited from Aspose.Words.Node
           Removes itself from the parent.
voidremoveAllChildren()→ inherited from Aspose.Words.CompositeNode
           Removes all the child nodes of the current node.
voidremoveSmartTags()→ inherited from Aspose.Words.CompositeNode
           Removes all SmartTag descendant nodes of the current node.
Aspose.Words.NodeListselectNodes(java.lang.String xpath)→ inherited from Aspose.Words.CompositeNode
           Selects a list of nodes matching the XPath expression.
Aspose.Words.NodeselectSingleNode(java.lang.String xpath)→ inherited from Aspose.Words.CompositeNode
           Selects the first Node that matches the XPath expression.
java.lang.StringtoString()
          
java.lang.StringtoString(SaveOptions saveOptions)→ inherited from Aspose.Words.Node
           Exports the content of the node into a string using the specified save options.
java.lang.StringtoTxt()→ inherited from Aspose.Words.Node
           Exports the content of the node into a string in plain text format.
 

Property Getters/Setters Detail

getChildNodes

→ inherited from Aspose.Words.CompositeNode
public Aspose.Words.NodeCollection getChildNodes()
Gets all immediate child nodes of this node.

Note, #Error Cref: P:Aspose.Words.CompositeNode.ChildNodes is equivalent to calling GetChildNodes(NodeType.Any, false) and creates and returns a new collection every time it is accessed.

If there are no child nodes, this property returns an empty collection.


getCount

→ inherited from Aspose.Words.CompositeNode
public int getCount()
Gets the number of immediate children of this node.

getDocument

→ inherited from Aspose.Words.Node
public Aspose.Words.DocumentBase getDocument()
Gets the document to which this node belongs.

The node always belongs to a document even if it has just been created and not yet added to the tree, or if it has been removed from the tree.


getElement/setElement

public java.lang.String getElement() / public void setElement(java.lang.String value)
Specifies the name of the smart tag within the document.

Cannot be null.

Default is empty string.


getFirstChild

→ inherited from Aspose.Words.CompositeNode
public Aspose.Words.Node getFirstChild()
Gets the first child of the node. If there is no first child node, a null is returned.

hasChildNodes

→ inherited from Aspose.Words.CompositeNode
public boolean hasChildNodes()
Returns true if this node has any child nodes.

isComposite

→ inherited from Aspose.Words.CompositeNode
public boolean isComposite()
Returns true as this node can have child nodes.

getLastChild

→ inherited from Aspose.Words.CompositeNode
public Aspose.Words.Node getLastChild()
Gets the last child of the node. If there is no last child node, a null is returned.

getNextSibling

→ inherited from Aspose.Words.Node
public Aspose.Words.Node getNextSibling()
Gets the node immediately following this node. If there is no next node, a null is returned.

getNodeType

public Aspose.Words.NodeType getNodeType()
Returns NodeType.SmartTag.

getParentNode

→ inherited from Aspose.Words.Node
public Aspose.Words.CompositeNode getParentNode()
Gets the immediate parent of this node.

If a node has just been created and not yet added to the tree, or if it has been removed from the tree, the parent is null.


getPreviousSibling

→ inherited from Aspose.Words.Node
public Aspose.Words.Node getPreviousSibling()
Gets the node immediately preceding this node. If there is no preceding node, a null is returned.

getProperties

public CustomXmlPropertyCollection getProperties()
A collection of the smart tag properties.

Cannot be null.


getRange

→ inherited from Aspose.Words.Node
public Aspose.Words.Range getRange()
Returns a Range object that represents the portion of a document that is contained in this node.

getUri/setUri

public java.lang.String getUri() / public void setUri(java.lang.String value)
Specifies the namespace URI of the smart tag.

Cannot be null.

Default is empty string.


Method Detail

dd

→ inherited from Aspose.Words.CompositeNode
public void dd()

deepClone

→ inherited from Aspose.Words.Node
public Aspose.Words.Node deepClone(boolean isCloneChildren)
Creates a duplicate of the node.

This method serves as a copy constructor for nodes. The cloned node has no parent, but belongs to the same document as the original node.

This method always performs a deep copy of the node. The isCloneChildren parameter specifies whether to perform copy all child nodes as well.

Parameters:
isCloneChildren - True to recursively clone the subtree under the specified node; false to clone only the node itself.
Returns:
The cloned node.

getAncestor

→ inherited from Aspose.Words.Node
public Aspose.Words.CompositeNode getAncestor(java.lang.Class ancestorType)
Gets the first ancestor of the specified object type.

The ancestor type matches if it is equal to ancestorType or derived from ancestorType.

Parameters:
ancestorType - The object type of the ancestor to retrieve.
Returns:
The ancestor of the specified type or null if no ancestor of this type was found.

getContainer

→ inherited from Aspose.Words.CompositeNode
public Aspose.Words.CompositeNode getContainer()
Reserved for internal use.

getLevel_IMarkupNode

public int getLevel_IMarkupNode()
Reserved for internal use.

getNextMatchingNode

→ inherited from Aspose.Words.CompositeNode
public Aspose.Words.Node getNextMatchingNode(aspose.obfuscated.type curNode)
Reserved for internal use.

getText

→ inherited from Aspose.Words.CompositeNode
public java.lang.String getText()
Gets the text of this node and of all its children.

The returned string includes all control and special characters as described in Aspose.Words.ControlChar.


iterator

→ inherited from Aspose.Words.CompositeNode
public java.util.Iterator iterator()
Provides support for the for each style iteration over the child nodes of this node.

remove

→ inherited from Aspose.Words.Node
public void remove()
Removes itself from the parent.

removeAllChildren

→ inherited from Aspose.Words.CompositeNode
public void removeAllChildren()
Removes all the child nodes of the current node.

removeSmartTags

→ inherited from Aspose.Words.CompositeNode
public void removeSmartTags()
Removes all SmartTag descendant nodes of the current node. This method does not remove the content of the smart tags.

selectNodes

→ inherited from Aspose.Words.CompositeNode
public Aspose.Words.NodeList selectNodes(java.lang.String xpath)
Selects a list of nodes matching the XPath expression.

Only expressions with element names are supported at the moment. Expressions that use attribute names are not supported.

Parameters:
xpath - The XPath expression.
Returns:
A list of nodes matching the XPath query.

selectSingleNode

→ inherited from Aspose.Words.CompositeNode
public Aspose.Words.Node selectSingleNode(java.lang.String xpath)
Selects the first Node that matches the XPath expression.

Only expressions with element names are supported at the moment. Expressions that use attribute names are not supported.

Parameters:
xpath - The XPath expression.
Returns:
The first Node that matches the XPath query or null if no matching node is found.

toString

public java.lang.String toString()

toString

→ inherited from Aspose.Words.Node
public java.lang.String toString(SaveOptions saveOptions)
               throws java.lang.Exception
Exports the content of the node into a string using the specified save options.
Parameters:
saveOptions - Specifies the options that control how the node is saved.
Returns:
The content of the node in the specified format.

toTxt

→ inherited from Aspose.Words.Node
public java.lang.String toTxt()
            throws java.lang.Exception
Exports the content of the node into a string in plain text format.

This method removes field codes and Microsoft Word control characters, uses CrLf (or any other) combination of characters to mark ends of paragraphs in the resulting string. It produces a different result from #Error Cref: M:Aspose.Words.Node.GetText which just gets the text from the node without removing field codes or special characters.

Returns:
The content of the node in plain text format.
See Also:
TxtSaveOptions.ParagraphBreak, TxtSaveOptions.ExportHeadersFooters

See Also:
          Aspose.Words Documentation - the home page for the Aspose.Words Product Documentation.
          Aspose.Words Support Forum - our preferred method of support.