com.aspose.words

Property Getters/Setters Detail

• getCount

  public int getCount()
  

  Gets the number of elements contained in the collection.

  Example:

  Shows how to work with an XML schema collection.

  // Create a document and add a custom XML part
  Document doc = new Document();
  
  String xmlPartId = UUID.randomUUID().toString();
  String xmlPartContent = "<root><text>Hello, World!</text></root>";
  CustomXmlPart xmlPart = doc.getCustomXmlParts().add(xmlPartId, xmlPartContent);
  
  // Once the part is created, we can add XML schema associations like this,
  // and perform other collection-related operations on the list of schemas for this part
  xmlPart.getSchemas().add("http://www.w3.org/2001/XMLSchema");
  
  // Collections can be cloned and elements can be added
  CustomXmlSchemaCollection schemas = xmlPart.getSchemas().deepClone();
  schemas.add("http://www.w3.org/2001/XMLSchema-instance");
  schemas.add("http://schemas.microsoft.com/office/2006/metadata/contentType");
  
  Assert.assertEquals(schemas.getCount(), 3);
  Assert.assertEquals(schemas.indexOf(("http://schemas.microsoft.com/office/2006/metadata/contentType")), 2);
  
  // We can iterate over the collection with an enumerator
  Iterator<String> enumerator = schemas.iterator();
  while (enumerator.hasNext()) {
      System.out.println(enumerator.next());
  }
  
  // We can also remove elements by index, element, or we can clear the entire collection
  schemas.removeAt(2);
  schemas.remove("http://www.w3.org/2001/XMLSchema");
  schemas.clear();
  
  Assert.assertEquals(schemas.getCount(), 0);

• get/set

  public java.lang.String get(int index) / public void set(int index, java.lang.String value)
  

  Gets or sets the element at the specified index.

  Example:

  Shows how to work with an XML schema collection.

  // Create a document and add a custom XML part
  Document doc = new Document();
  
  String xmlPartId = UUID.randomUUID().toString();
  String xmlPartContent = "<root><text>Hello, World!</text></root>";
  CustomXmlPart xmlPart = doc.getCustomXmlParts().add(xmlPartId, xmlPartContent);
  
  // Once the part is created, we can add XML schema associations like this,
  // and perform other collection-related operations on the list of schemas for this part
  xmlPart.getSchemas().add("http://www.w3.org/2001/XMLSchema");
  
  // Collections can be cloned and elements can be added
  CustomXmlSchemaCollection schemas = xmlPart.getSchemas().deepClone();
  schemas.add("http://www.w3.org/2001/XMLSchema-instance");
  schemas.add("http://schemas.microsoft.com/office/2006/metadata/contentType");
  
  Assert.assertEquals(schemas.getCount(), 3);
  Assert.assertEquals(schemas.indexOf(("http://schemas.microsoft.com/office/2006/metadata/contentType")), 2);
  
  // We can iterate over the collection with an enumerator
  Iterator<String> enumerator = schemas.iterator();
  while (enumerator.hasNext()) {
      System.out.println(enumerator.next());
  }
  
  // We can also remove elements by index, element, or we can clear the entire collection
  schemas.removeAt(2);
  schemas.remove("http://www.w3.org/2001/XMLSchema");
  schemas.clear();
  
  Assert.assertEquals(schemas.getCount(), 0);

Method Detail

• add

  public void add(java.lang.String value)

  Adds an item to the collection.

  Parameters:

  value - The item to add.

  Example:

  Shows how to work with an XML schema collection.

  // Create a document and add a custom XML part
  Document doc = new Document();
  
  String xmlPartId = UUID.randomUUID().toString();
  String xmlPartContent = "<root><text>Hello, World!</text></root>";
  CustomXmlPart xmlPart = doc.getCustomXmlParts().add(xmlPartId, xmlPartContent);
  
  // Once the part is created, we can add XML schema associations like this,
  // and perform other collection-related operations on the list of schemas for this part
  xmlPart.getSchemas().add("http://www.w3.org/2001/XMLSchema");
  
  // Collections can be cloned and elements can be added
  CustomXmlSchemaCollection schemas = xmlPart.getSchemas().deepClone();
  schemas.add("http://www.w3.org/2001/XMLSchema-instance");
  schemas.add("http://schemas.microsoft.com/office/2006/metadata/contentType");
  
  Assert.assertEquals(schemas.getCount(), 3);
  Assert.assertEquals(schemas.indexOf(("http://schemas.microsoft.com/office/2006/metadata/contentType")), 2);
  
  // We can iterate over the collection with an enumerator
  Iterator<String> enumerator = schemas.iterator();
  while (enumerator.hasNext()) {
      System.out.println(enumerator.next());
  }
  
  // We can also remove elements by index, element, or we can clear the entire collection
  schemas.removeAt(2);
  schemas.remove("http://www.w3.org/2001/XMLSchema");
  schemas.clear();
  
  Assert.assertEquals(schemas.getCount(), 0);

• clear

  public void clear()

  Removes all elements from the collection.

  Example:

  Shows how to work with an XML schema collection.

  // Create a document and add a custom XML part
  Document doc = new Document();
  
  String xmlPartId = UUID.randomUUID().toString();
  String xmlPartContent = "<root><text>Hello, World!</text></root>";
  CustomXmlPart xmlPart = doc.getCustomXmlParts().add(xmlPartId, xmlPartContent);
  
  // Once the part is created, we can add XML schema associations like this,
  // and perform other collection-related operations on the list of schemas for this part
  xmlPart.getSchemas().add("http://www.w3.org/2001/XMLSchema");
  
  // Collections can be cloned and elements can be added
  CustomXmlSchemaCollection schemas = xmlPart.getSchemas().deepClone();
  schemas.add("http://www.w3.org/2001/XMLSchema-instance");
  schemas.add("http://schemas.microsoft.com/office/2006/metadata/contentType");
  
  Assert.assertEquals(schemas.getCount(), 3);
  Assert.assertEquals(schemas.indexOf(("http://schemas.microsoft.com/office/2006/metadata/contentType")), 2);
  
  // We can iterate over the collection with an enumerator
  Iterator<String> enumerator = schemas.iterator();
  while (enumerator.hasNext()) {
      System.out.println(enumerator.next());
  }
  
  // We can also remove elements by index, element, or we can clear the entire collection
  schemas.removeAt(2);
  schemas.remove("http://www.w3.org/2001/XMLSchema");
  schemas.clear();
  
  Assert.assertEquals(schemas.getCount(), 0);

• deepClone

  public CustomXmlSchemaCollection deepClone()

  Makes a deep clone of this object.

  Example:

  Shows how to work with an XML schema collection.

  // Create a document and add a custom XML part
  Document doc = new Document();
  
  String xmlPartId = UUID.randomUUID().toString();
  String xmlPartContent = "<root><text>Hello, World!</text></root>";
  CustomXmlPart xmlPart = doc.getCustomXmlParts().add(xmlPartId, xmlPartContent);
  
  // Once the part is created, we can add XML schema associations like this,
  // and perform other collection-related operations on the list of schemas for this part
  xmlPart.getSchemas().add("http://www.w3.org/2001/XMLSchema");
  
  // Collections can be cloned and elements can be added
  CustomXmlSchemaCollection schemas = xmlPart.getSchemas().deepClone();
  schemas.add("http://www.w3.org/2001/XMLSchema-instance");
  schemas.add("http://schemas.microsoft.com/office/2006/metadata/contentType");
  
  Assert.assertEquals(schemas.getCount(), 3);
  Assert.assertEquals(schemas.indexOf(("http://schemas.microsoft.com/office/2006/metadata/contentType")), 2);
  
  // We can iterate over the collection with an enumerator
  Iterator<String> enumerator = schemas.iterator();
  while (enumerator.hasNext()) {
      System.out.println(enumerator.next());
  }
  
  // We can also remove elements by index, element, or we can clear the entire collection
  schemas.removeAt(2);
  schemas.remove("http://www.w3.org/2001/XMLSchema");
  schemas.clear();
  
  Assert.assertEquals(schemas.getCount(), 0);

• indexOf

  public int indexOf(java.lang.String value)

  Returns the zero-based index of the specified value in the collection.

  Parameters:

  value - The case-sensitive value to locate.

  Returns:

  The zero based index. Negative value if not found.

  Example:

  Shows how to work with an XML schema collection.

  // Create a document and add a custom XML part
  Document doc = new Document();
  
  String xmlPartId = UUID.randomUUID().toString();
  String xmlPartContent = "<root><text>Hello, World!</text></root>";
  CustomXmlPart xmlPart = doc.getCustomXmlParts().add(xmlPartId, xmlPartContent);
  
  // Once the part is created, we can add XML schema associations like this,
  // and perform other collection-related operations on the list of schemas for this part
  xmlPart.getSchemas().add("http://www.w3.org/2001/XMLSchema");
  
  // Collections can be cloned and elements can be added
  CustomXmlSchemaCollection schemas = xmlPart.getSchemas().deepClone();
  schemas.add("http://www.w3.org/2001/XMLSchema-instance");
  schemas.add("http://schemas.microsoft.com/office/2006/metadata/contentType");
  
  Assert.assertEquals(schemas.getCount(), 3);
  Assert.assertEquals(schemas.indexOf(("http://schemas.microsoft.com/office/2006/metadata/contentType")), 2);
  
  // We can iterate over the collection with an enumerator
  Iterator<String> enumerator = schemas.iterator();
  while (enumerator.hasNext()) {
      System.out.println(enumerator.next());
  }
  
  // We can also remove elements by index, element, or we can clear the entire collection
  schemas.removeAt(2);
  schemas.remove("http://www.w3.org/2001/XMLSchema");
  schemas.clear();
  
  Assert.assertEquals(schemas.getCount(), 0);

• iterator

  public java.util.Iterator<java.lang.String> iterator()

  Returns an iterator object that can be used to iterate over all items in the collection.

  Example:

  Shows how to work with an XML schema collection.

  // Create a document and add a custom XML part
  Document doc = new Document();
  
  String xmlPartId = UUID.randomUUID().toString();
  String xmlPartContent = "<root><text>Hello, World!</text></root>";
  CustomXmlPart xmlPart = doc.getCustomXmlParts().add(xmlPartId, xmlPartContent);
  
  // Once the part is created, we can add XML schema associations like this,
  // and perform other collection-related operations on the list of schemas for this part
  xmlPart.getSchemas().add("http://www.w3.org/2001/XMLSchema");
  
  // Collections can be cloned and elements can be added
  CustomXmlSchemaCollection schemas = xmlPart.getSchemas().deepClone();
  schemas.add("http://www.w3.org/2001/XMLSchema-instance");
  schemas.add("http://schemas.microsoft.com/office/2006/metadata/contentType");
  
  Assert.assertEquals(schemas.getCount(), 3);
  Assert.assertEquals(schemas.indexOf(("http://schemas.microsoft.com/office/2006/metadata/contentType")), 2);
  
  // We can iterate over the collection with an enumerator
  Iterator<String> enumerator = schemas.iterator();
  while (enumerator.hasNext()) {
      System.out.println(enumerator.next());
  }
  
  // We can also remove elements by index, element, or we can clear the entire collection
  schemas.removeAt(2);
  schemas.remove("http://www.w3.org/2001/XMLSchema");
  schemas.clear();
  
  Assert.assertEquals(schemas.getCount(), 0);

• remove

  public void remove(java.lang.String name)

  Removes the specified value from the collection.

  Parameters:

  name - The case-sensitive value to remove.

  Example:

  Shows how to work with an XML schema collection.

  // Create a document and add a custom XML part
  Document doc = new Document();
  
  String xmlPartId = UUID.randomUUID().toString();
  String xmlPartContent = "<root><text>Hello, World!</text></root>";
  CustomXmlPart xmlPart = doc.getCustomXmlParts().add(xmlPartId, xmlPartContent);
  
  // Once the part is created, we can add XML schema associations like this,
  // and perform other collection-related operations on the list of schemas for this part
  xmlPart.getSchemas().add("http://www.w3.org/2001/XMLSchema");
  
  // Collections can be cloned and elements can be added
  CustomXmlSchemaCollection schemas = xmlPart.getSchemas().deepClone();
  schemas.add("http://www.w3.org/2001/XMLSchema-instance");
  schemas.add("http://schemas.microsoft.com/office/2006/metadata/contentType");
  
  Assert.assertEquals(schemas.getCount(), 3);
  Assert.assertEquals(schemas.indexOf(("http://schemas.microsoft.com/office/2006/metadata/contentType")), 2);
  
  // We can iterate over the collection with an enumerator
  Iterator<String> enumerator = schemas.iterator();
  while (enumerator.hasNext()) {
      System.out.println(enumerator.next());
  }
  
  // We can also remove elements by index, element, or we can clear the entire collection
  schemas.removeAt(2);
  schemas.remove("http://www.w3.org/2001/XMLSchema");
  schemas.clear();
  
  Assert.assertEquals(schemas.getCount(), 0);

• removeAt

  public void removeAt(int index)

  Removes a value at the specified index.

  Parameters:

  index - The zero based index.

  Example:

  Shows how to work with an XML schema collection.

  // Create a document and add a custom XML part
  Document doc = new Document();
  
  String xmlPartId = UUID.randomUUID().toString();
  String xmlPartContent = "<root><text>Hello, World!</text></root>";
  CustomXmlPart xmlPart = doc.getCustomXmlParts().add(xmlPartId, xmlPartContent);
  
  // Once the part is created, we can add XML schema associations like this,
  // and perform other collection-related operations on the list of schemas for this part
  xmlPart.getSchemas().add("http://www.w3.org/2001/XMLSchema");
  
  // Collections can be cloned and elements can be added
  CustomXmlSchemaCollection schemas = xmlPart.getSchemas().deepClone();
  schemas.add("http://www.w3.org/2001/XMLSchema-instance");
  schemas.add("http://schemas.microsoft.com/office/2006/metadata/contentType");
  
  Assert.assertEquals(schemas.getCount(), 3);
  Assert.assertEquals(schemas.indexOf(("http://schemas.microsoft.com/office/2006/metadata/contentType")), 2);
  
  // We can iterate over the collection with an enumerator
  Iterator<String> enumerator = schemas.iterator();
  while (enumerator.hasNext()) {
      System.out.println(enumerator.next());
  }
  
  // We can also remove elements by index, element, or we can clear the entire collection
  schemas.removeAt(2);
  schemas.remove("http://www.w3.org/2001/XMLSchema");
  schemas.clear();
  
  Assert.assertEquals(schemas.getCount(), 0);