com.aspose.words
Class CustomXmlProperty

java.lang.Object
    com.aspose.words.CustomXmlProperty

All Implemented Interfaces:

java.lang.Cloneable

public class CustomXmlProperty 
extends java.lang.Object

public void create() throws Exception {
    Document doc = new Document();

    // A smart tag appears in a document with Microsoft Word recognizes a part of its text as some form of data,
    // such as a name, date, or address, and converts it to a hyperlink that displays a purple dotted underline.
    SmartTag smartTag = new SmartTag(doc);

    // Smart tags are composite nodes that contain their recognized text in its entirety.
    // Add contents to this smart tag manually.
    smartTag.appendChild(new Run(doc, "May 29, 2019"));

    // Microsoft Word may recognize the above contents as being a date.
    // Smart tags use the "Element" property to reflect the type of data they contain.
    smartTag.setElement("date");

    // Some smart tag types process their contents further into custom XML properties.
    smartTag.getProperties().add(new CustomXmlProperty("Day", "", "29"));
    smartTag.getProperties().add(new CustomXmlProperty("Month", "", "5"));
    smartTag.getProperties().add(new CustomXmlProperty("Year", "", "2019"));

    // Set the smart tag's URI to the default value.
    smartTag.setUri("urn:schemas-microsoft-com:office:smarttags");

    doc.getFirstSection().getBody().getFirstParagraph().appendChild(smartTag);
    doc.getFirstSection().getBody().getFirstParagraph().appendChild(new Run(doc, " is a date. "));

    // Create another smart tag for a stock ticker.
    smartTag = new SmartTag(doc);
    smartTag.setElement("stockticker");
    smartTag.setUri("urn:schemas-microsoft-com:office:smarttags");

    smartTag.appendChild(new Run(doc, "MSFT"));

    doc.getFirstSection().getBody().getFirstParagraph().appendChild(smartTag);
    doc.getFirstSection().getBody().getFirstParagraph().appendChild(new Run(doc, " is a stock ticker."));

    // Print all the smart tags in our document using a document visitor.
    doc.accept(new SmartTagPrinter());

    // Older versions of Microsoft Word support smart tags.
    doc.save(getArtifactsDir() + "SmartTag.Create.doc");

    // Use the "RemoveSmartTags" method to remove all smart tags from a document.
    Assert.assertEquals(2, doc.getChildNodes(NodeType.SMART_TAG, true).getCount());

    doc.removeSmartTags();

    Assert.assertEquals(0, doc.getChildNodes(NodeType.SMART_TAG, true).getCount());
}

/// <summary>
/// Prints visited smart tags and their contents.
/// </summary>
private static class SmartTagPrinter extends DocumentVisitor {
    /// <summary>
    /// Called when a SmartTag node is encountered in the document.
    /// </summary>
    public /*override*/ /*VisitorAction*/int visitSmartTagStart(SmartTag smartTag) {
        System.out.println("Smart tag type: {smartTag.Element}");
        return VisitorAction.CONTINUE;
    }

    /// <summary>
    /// Called when the visiting of a SmartTag node is ended.
    /// </summary>
    public /*override*/ /*VisitorAction*/int visitSmartTagEnd(SmartTag smartTag) {
        System.out.println("\tContents: \"{smartTag.ToString(SaveFormat.Text)}\"");

        if (smartTag.getProperties().getCount() == 0) {
            System.out.println("\tContains no properties");
        } else {
            System.out.println("\tProperties: ");
            String[] properties = new String[smartTag.getProperties().getCount()];
            int index = 0;

            for (CustomXmlProperty cxp : smartTag.getProperties())
                properties[index++] = MessageFormat.format("\"{0}\" = \"{1}\"", cxp.getName(), cxp.getValue());

            System.out.println(StringUtils.join(properties, ", "));
        }

        return VisitorAction.CONTINUE;
    }
}

CustomXmlProperty

public CustomXmlProperty(java.lang.String name, java.lang.String uri, java.lang.String value)

Initializes a new instance of this class.

Parameters:

name - The name of the property. Cannot be null.

uri - The namespace URI of the property. Cannot be null.

value - The value of the property. Cannot be null.

Example:

Shows how to create smart tags.

public void create() throws Exception {
    Document doc = new Document();

    // A smart tag appears in a document with Microsoft Word recognizes a part of its text as some form of data,
    // such as a name, date, or address, and converts it to a hyperlink that displays a purple dotted underline.
    SmartTag smartTag = new SmartTag(doc);

    // Smart tags are composite nodes that contain their recognized text in its entirety.
    // Add contents to this smart tag manually.
    smartTag.appendChild(new Run(doc, "May 29, 2019"));

    // Microsoft Word may recognize the above contents as being a date.
    // Smart tags use the "Element" property to reflect the type of data they contain.
    smartTag.setElement("date");

    // Some smart tag types process their contents further into custom XML properties.
    smartTag.getProperties().add(new CustomXmlProperty("Day", "", "29"));
    smartTag.getProperties().add(new CustomXmlProperty("Month", "", "5"));
    smartTag.getProperties().add(new CustomXmlProperty("Year", "", "2019"));

    // Set the smart tag's URI to the default value.
    smartTag.setUri("urn:schemas-microsoft-com:office:smarttags");

    doc.getFirstSection().getBody().getFirstParagraph().appendChild(smartTag);
    doc.getFirstSection().getBody().getFirstParagraph().appendChild(new Run(doc, " is a date. "));

    // Create another smart tag for a stock ticker.
    smartTag = new SmartTag(doc);
    smartTag.setElement("stockticker");
    smartTag.setUri("urn:schemas-microsoft-com:office:smarttags");

    smartTag.appendChild(new Run(doc, "MSFT"));

    doc.getFirstSection().getBody().getFirstParagraph().appendChild(smartTag);
    doc.getFirstSection().getBody().getFirstParagraph().appendChild(new Run(doc, " is a stock ticker."));

    // Print all the smart tags in our document using a document visitor.
    doc.accept(new SmartTagPrinter());

    // Older versions of Microsoft Word support smart tags.
    doc.save(getArtifactsDir() + "SmartTag.Create.doc");

    // Use the "RemoveSmartTags" method to remove all smart tags from a document.
    Assert.assertEquals(2, doc.getChildNodes(NodeType.SMART_TAG, true).getCount());

    doc.removeSmartTags();

    Assert.assertEquals(0, doc.getChildNodes(NodeType.SMART_TAG, true).getCount());
}

/// <summary>
/// Prints visited smart tags and their contents.
/// </summary>
private static class SmartTagPrinter extends DocumentVisitor {
    /// <summary>
    /// Called when a SmartTag node is encountered in the document.
    /// </summary>
    public /*override*/ /*VisitorAction*/int visitSmartTagStart(SmartTag smartTag) {
        System.out.println("Smart tag type: {smartTag.Element}");
        return VisitorAction.CONTINUE;
    }

    /// <summary>
    /// Called when the visiting of a SmartTag node is ended.
    /// </summary>
    public /*override*/ /*VisitorAction*/int visitSmartTagEnd(SmartTag smartTag) {
        System.out.println("\tContents: \"{smartTag.ToString(SaveFormat.Text)}\"");

        if (smartTag.getProperties().getCount() == 0) {
            System.out.println("\tContains no properties");
        } else {
            System.out.println("\tProperties: ");
            String[] properties = new String[smartTag.getProperties().getCount()];
            int index = 0;

            for (CustomXmlProperty cxp : smartTag.getProperties())
                properties[index++] = MessageFormat.format("\"{0}\" = \"{1}\"", cxp.getName(), cxp.getValue());

            System.out.println(StringUtils.join(properties, ", "));
        }

        return VisitorAction.CONTINUE;
    }
}

public java.lang.String getName()

Specifies the name of the custom XML attribute or smart tag property.

Cannot be null.

Default is empty string.

Example:

Shows how to create smart tags.

public void create() throws Exception {
    Document doc = new Document();

    // A smart tag appears in a document with Microsoft Word recognizes a part of its text as some form of data,
    // such as a name, date, or address, and converts it to a hyperlink that displays a purple dotted underline.
    SmartTag smartTag = new SmartTag(doc);

    // Smart tags are composite nodes that contain their recognized text in its entirety.
    // Add contents to this smart tag manually.
    smartTag.appendChild(new Run(doc, "May 29, 2019"));

    // Microsoft Word may recognize the above contents as being a date.
    // Smart tags use the "Element" property to reflect the type of data they contain.
    smartTag.setElement("date");

    // Some smart tag types process their contents further into custom XML properties.
    smartTag.getProperties().add(new CustomXmlProperty("Day", "", "29"));
    smartTag.getProperties().add(new CustomXmlProperty("Month", "", "5"));
    smartTag.getProperties().add(new CustomXmlProperty("Year", "", "2019"));

    // Set the smart tag's URI to the default value.
    smartTag.setUri("urn:schemas-microsoft-com:office:smarttags");

    doc.getFirstSection().getBody().getFirstParagraph().appendChild(smartTag);
    doc.getFirstSection().getBody().getFirstParagraph().appendChild(new Run(doc, " is a date. "));

    // Create another smart tag for a stock ticker.
    smartTag = new SmartTag(doc);
    smartTag.setElement("stockticker");
    smartTag.setUri("urn:schemas-microsoft-com:office:smarttags");

    smartTag.appendChild(new Run(doc, "MSFT"));

    doc.getFirstSection().getBody().getFirstParagraph().appendChild(smartTag);
    doc.getFirstSection().getBody().getFirstParagraph().appendChild(new Run(doc, " is a stock ticker."));

    // Print all the smart tags in our document using a document visitor.
    doc.accept(new SmartTagPrinter());

    // Older versions of Microsoft Word support smart tags.
    doc.save(getArtifactsDir() + "SmartTag.Create.doc");

    // Use the "RemoveSmartTags" method to remove all smart tags from a document.
    Assert.assertEquals(2, doc.getChildNodes(NodeType.SMART_TAG, true).getCount());

    doc.removeSmartTags();

    Assert.assertEquals(0, doc.getChildNodes(NodeType.SMART_TAG, true).getCount());
}

/// <summary>
/// Prints visited smart tags and their contents.
/// </summary>
private static class SmartTagPrinter extends DocumentVisitor {
    /// <summary>
    /// Called when a SmartTag node is encountered in the document.
    /// </summary>
    public /*override*/ /*VisitorAction*/int visitSmartTagStart(SmartTag smartTag) {
        System.out.println("Smart tag type: {smartTag.Element}");
        return VisitorAction.CONTINUE;
    }

    /// <summary>
    /// Called when the visiting of a SmartTag node is ended.
    /// </summary>
    public /*override*/ /*VisitorAction*/int visitSmartTagEnd(SmartTag smartTag) {
        System.out.println("\tContents: \"{smartTag.ToString(SaveFormat.Text)}\"");

        if (smartTag.getProperties().getCount() == 0) {
            System.out.println("\tContains no properties");
        } else {
            System.out.println("\tProperties: ");
            String[] properties = new String[smartTag.getProperties().getCount()];
            int index = 0;

            for (CustomXmlProperty cxp : smartTag.getProperties())
                properties[index++] = MessageFormat.format("\"{0}\" = \"{1}\"", cxp.getName(), cxp.getValue());

            System.out.println(StringUtils.join(properties, ", "));
        }

        return VisitorAction.CONTINUE;
    }
}

public java.lang.String getUri() / public void setUri(java.lang.String value)

Gets or sets the namespace URI of the custom XML attribute or smart tag property.

Cannot be null.

Default is empty string.

Example:

Shows how to work with smart tag properties to get in depth information about smart tags.

Document doc = new Document(getMyDir() + "Smart tags.doc");

// A smart tag appears in a document with Microsoft Word recognizes a part of its text as some form of data,
// such as a name, date, or address, and converts it to a hyperlink that displays a purple dotted underline.
// In Word 2003, we can enable smart tags via "Tools" -> "AutoCorrect options..." -> "SmartTags".
// In our input document, there are three objects that Microsoft Word registered as smart tags.
// Smart tags may be nested, so this collection contains more.
List<SmartTag> smartTags = Arrays.stream(doc.getChildNodes(NodeType.SMART_TAG, true).toArray())
        .filter(SmartTag.class::isInstance)
        .map(SmartTag.class::cast)
        .collect(Collectors.toList());

Assert.assertEquals(8, smartTags.size());

// The "Properties" member of a smart tag contains its metadata, which will be different for each type of smart tag.
// The properties of a "date"-type smart tag contain its year, month, and day.
CustomXmlPropertyCollection properties = smartTags.get(7).getProperties();

Assert.assertEquals(4, properties.getCount());

Iterator<CustomXmlProperty> enumerator = properties.iterator();

while (enumerator.hasNext()) {
    CustomXmlProperty customXmlProperty = enumerator.next();

    System.out.println(MessageFormat.format("Property name: {0}, value: {1}", customXmlProperty.getName(), customXmlProperty.getValue()));
    Assert.assertEquals("", enumerator.next().getUri());
}

// We can also access the properties in various ways, such as a key-value pair.
Assert.assertTrue(properties.contains("Day"));
Assert.assertEquals("22", properties.get("Day").getValue());
Assert.assertEquals("2003", properties.get(2).getValue());
Assert.assertEquals(1, properties.indexOfKey("Month"));

// Below are three ways of removing elements from the properties collection.
// 1 -  Remove by index:
properties.removeAt(3);

Assert.assertEquals(3, properties.getCount());

// 2 -  Remove by name:
properties.remove("Year");

Assert.assertEquals(2, properties.getCount());

// 3 -  Clear the entire collection at once:
properties.clear();

Assert.assertEquals(0, properties.getCount());

public java.lang.String getValue() / public void setValue(java.lang.String value)

Gets or sets the value of the custom XML attribute or smart tag property.

Cannot be null.

Default is empty string.

Example:

Shows how to create smart tags.

public void create() throws Exception {
    Document doc = new Document();

    // A smart tag appears in a document with Microsoft Word recognizes a part of its text as some form of data,
    // such as a name, date, or address, and converts it to a hyperlink that displays a purple dotted underline.
    SmartTag smartTag = new SmartTag(doc);

    // Smart tags are composite nodes that contain their recognized text in its entirety.
    // Add contents to this smart tag manually.
    smartTag.appendChild(new Run(doc, "May 29, 2019"));

    // Microsoft Word may recognize the above contents as being a date.
    // Smart tags use the "Element" property to reflect the type of data they contain.
    smartTag.setElement("date");

    // Some smart tag types process their contents further into custom XML properties.
    smartTag.getProperties().add(new CustomXmlProperty("Day", "", "29"));
    smartTag.getProperties().add(new CustomXmlProperty("Month", "", "5"));
    smartTag.getProperties().add(new CustomXmlProperty("Year", "", "2019"));

    // Set the smart tag's URI to the default value.
    smartTag.setUri("urn:schemas-microsoft-com:office:smarttags");

    doc.getFirstSection().getBody().getFirstParagraph().appendChild(smartTag);
    doc.getFirstSection().getBody().getFirstParagraph().appendChild(new Run(doc, " is a date. "));

    // Create another smart tag for a stock ticker.
    smartTag = new SmartTag(doc);
    smartTag.setElement("stockticker");
    smartTag.setUri("urn:schemas-microsoft-com:office:smarttags");

    smartTag.appendChild(new Run(doc, "MSFT"));

    doc.getFirstSection().getBody().getFirstParagraph().appendChild(smartTag);
    doc.getFirstSection().getBody().getFirstParagraph().appendChild(new Run(doc, " is a stock ticker."));

    // Print all the smart tags in our document using a document visitor.
    doc.accept(new SmartTagPrinter());

    // Older versions of Microsoft Word support smart tags.
    doc.save(getArtifactsDir() + "SmartTag.Create.doc");

    // Use the "RemoveSmartTags" method to remove all smart tags from a document.
    Assert.assertEquals(2, doc.getChildNodes(NodeType.SMART_TAG, true).getCount());

    doc.removeSmartTags();

    Assert.assertEquals(0, doc.getChildNodes(NodeType.SMART_TAG, true).getCount());
}

/// <summary>
/// Prints visited smart tags and their contents.
/// </summary>
private static class SmartTagPrinter extends DocumentVisitor {
    /// <summary>
    /// Called when a SmartTag node is encountered in the document.
    /// </summary>
    public /*override*/ /*VisitorAction*/int visitSmartTagStart(SmartTag smartTag) {
        System.out.println("Smart tag type: {smartTag.Element}");
        return VisitorAction.CONTINUE;
    }

    /// <summary>
    /// Called when the visiting of a SmartTag node is ended.
    /// </summary>
    public /*override*/ /*VisitorAction*/int visitSmartTagEnd(SmartTag smartTag) {
        System.out.println("\tContents: \"{smartTag.ToString(SaveFormat.Text)}\"");

        if (smartTag.getProperties().getCount() == 0) {
            System.out.println("\tContains no properties");
        } else {
            System.out.println("\tProperties: ");
            String[] properties = new String[smartTag.getProperties().getCount()];
            int index = 0;

            for (CustomXmlProperty cxp : smartTag.getProperties())
                properties[index++] = MessageFormat.format("\"{0}\" = \"{1}\"", cxp.getName(), cxp.getValue());

            System.out.println(StringUtils.join(properties, ", "));
        }

        return VisitorAction.CONTINUE;
    }
}