IXmpDateArray Interface

Defines an XMP date array.

Declaration

public interface IXmpDateArray extends IXmpArray<XmpDate>

Remarks

The IXmpDateArray interface introduces methods to add, remove, search, and check date values in an XMP metadata array.

Refer to the following help topic for additional information: Manage PDF Document Properties and XMP Metadata.

Implements

com.devexpress.docs.pdf.IXmpArray<com.devexpress.docs.pdf.XmpDate>

Methods

add(DateTime value, XmpDatePrecision precision) Method

Adds an XMP date value with the specified precision.

Declaration

public abstract XmpDate add(DateTime value, XmpDatePrecision precision)

Parameters

Name	Type	Description
value	DateTime	The XMP date value.
precision	XmpDatePrecision	The XMP date precision.

Returns

Type	Description
XmpDate	The added XMP date value.

add(DateTime value) Method

Adds an XMP date value.

Declaration

public abstract XmpDate add(DateTime value)

Parameters

Name	Type	Description
value	DateTime	The XMP date value.

Returns

Type	Description
XmpDate	The added XMP date value.

add(DateTimeOffset value, XmpDatePrecision precision) Method

Adds an XMP date value with an offset and precision.

Declaration

public abstract XmpDate add(DateTimeOffset value, XmpDatePrecision precision)

Parameters

Name	Type	Description
value	DateTimeOffset	The XMP date value with an offset.
precision	XmpDatePrecision	The XMP date precision.

Returns

Type	Description
XmpDate	The added XMP date value with an offset.

add(DateTimeOffset value) Method

Adds an XMP date value with an offset.

Declaration

public abstract XmpDate add(DateTimeOffset value)

Parameters

Name	Type	Description
value	DateTimeOffset	The XMP date value with an offset.

Returns

Type	Description
XmpDate	The added XMP date value with an offset.

contains(DateTime value) Method

Returns whether the array contains the specified XMP date value.

Declaration

public abstract boolean contains(DateTime value)

Parameters

Name	Type	Description
value	DateTime	The XMP date value.

Returns

Type	Description
boolean	true if the array contains the value; otherwise, false.

contains(DateTimeOffset value) Method

Returns whether the array contains the specified XMP date value with an offset.

Declaration

public abstract boolean contains(DateTimeOffset value)

Parameters

Name	Type	Description
value	DateTimeOffset	The XMP date value with an offset.

Returns

Type	Description
boolean	true if the array contains the value with an offset; otherwise, false.

indexOf(DateTime value) Method

Returns the index of the specified XMP date value.

Declaration

public abstract int indexOf(DateTime value)

Parameters

Name	Type	Description
value	DateTime	The XMP date value.

Returns

Type	Description
int	The zero-based index of the XMP date value.

indexOf(DateTimeOffset value) Method

Returns the index of the specified XMP date value with an offset.

Declaration

public abstract int indexOf(DateTimeOffset value)

Parameters

Name	Type	Description
value	DateTimeOffset	The XMP date value with an offset.

Returns

Type	Description
int	The zero-based index of the XMP date value with an offset.

remove(DateTime value) Method

Removes the specified XMP date value.

Declaration

public abstract boolean remove(DateTime value)

Parameters

Name	Type	Description
value	DateTime	The XMP date value.

Returns

Type	Description
boolean	true if the value is removed; otherwise, false.

remove(DateTimeOffset value) Method

Removes the specified XMP date value with an offset.

Declaration

public abstract boolean remove(DateTimeOffset value)

Parameters

Name	Type	Description
value	DateTimeOffset	The XMP date value with an offset.

Returns

Type	Description
boolean	true if the value with an offset is removed; otherwise, false.