com.aspose.words

Class PropertyType

java.lang.Object

com.aspose.words.PropertyType

public class PropertyType
extends java.lang.Object

Specifies data type of a document property.

Examples:

Shows how to work with a document's custom properties.

 
 Document doc = new Document();
 CustomDocumentProperties properties = doc.getCustomDocumentProperties();

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

 // Custom document properties are key-value pairs that we can add to the document.
 properties.add("Authorized", true);
 properties.add("Authorized By", "John Doe");
 properties.add("Authorized Date", new Date());
 properties.add("Authorized Revision", doc.getBuiltInDocumentProperties().getRevisionNumber());
 properties.add("Authorized Amount", 123.45);

 // The collection sorts the custom properties in alphabetic order.
 Assert.assertEquals(1, properties.indexOf("Authorized Amount"));
 Assert.assertEquals(5, properties.getCount());

 // Print every custom property in the document.
 Iterator<DocumentProperty> enumerator = properties.iterator();
 while (enumerator.hasNext()) {
     DocumentProperty property = enumerator.next();
     System.out.println(MessageFormat.format("Name: \"{0}\"\n\tType: \"{1}\"\n\tValue: \"{2}\"", property.getName(), property.getType(), property.getValue()));
 }

 // Display the value of a custom property using a DOCPROPERTY field.
 DocumentBuilder builder = new DocumentBuilder(doc);
 FieldDocProperty field = (FieldDocProperty) builder.insertField(" DOCPROPERTY \"Authorized By\"");
 field.update();

 Assert.assertEquals("John Doe", field.getResult());

 // We can find these custom properties in Microsoft Word via "File" -> "Properties" > "Advanced Properties" > "Custom".
 doc.save(getArtifactsDir() + "DocumentProperties.DocumentPropertyCollection.docx");

 // Below are three ways or removing custom properties from a document.
 // 1 -  Remove by index:
 properties.removeAt(1);

 Assert.assertFalse(properties.contains("Authorized Amount"));
 Assert.assertEquals(4, properties.getCount());

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

 Assert.assertFalse(properties.contains("Authorized Revision"));
 Assert.assertEquals(3, properties.getCount());

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

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

See Also:

DocumentProperty, DocumentProperty.getType()

Field Summary

Fields

Modifier and Type	Field and Description
static int	BOOLEAN The property is a boolean value.
static int	BYTE_ARRAY The property is an array of bytes.
static int	DATE_TIME The property is a date time value.
static int	DOUBLE The property is a floating number.
static int	length
static int	NUMBER The property is an integer number.
static int	OBJECT_ARRAY The property is an array of objects.
static int	OTHER The property is some other type.
static int	STRING The property is a string value.
static int	STRING_ARRAY The property is an array of strings.

Method Summary

Modifier and Type	Method and Description
static int	fromName(java.lang.String propertyTypeName)
static java.lang.String	getName(int propertyType)
static int[]	getValues()
static java.lang.String	toString(int propertyType)

Methods inherited from class java.lang.Object

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

Field Detail

BOOLEAN

public static int BOOLEAN

The property is a boolean value.

DATE_TIME

public static int DATE_TIME

The property is a date time value.

DOUBLE

public static int DOUBLE

The property is a floating number.

NUMBER

public static int NUMBER

The property is an integer number.

STRING

public static int STRING

The property is a string value.

STRING_ARRAY

public static int STRING_ARRAY

The property is an array of strings.

OBJECT_ARRAY

public static int OBJECT_ARRAY

The property is an array of objects.

BYTE_ARRAY

public static int BYTE_ARRAY

The property is an array of bytes.

OTHER

public static int OTHER

The property is some other type.

length

public static int length

Method Detail

getName

public static java.lang.String getName(int propertyType)

toString

public static java.lang.String toString(int propertyType)

fromName

public static int fromName(java.lang.String propertyTypeName)

getValues

public static int[] getValues()