DOCPROPERTY

Syntax:

DOCPROPERTY docprop-category [ field-argument ] [ switches ]

docprop-category:AUTHOR | BYTES | CATEGORY | CHARACTERS | CHARACTERSWITHSPACES | COMMENTS | COMPANY | CREATETIME | HYPERLINKBASE | KEYWORDS | LASTPRINTED | LASTSAVEDBY | LASTSAVEDTIME | LINES | MANAGER | NAMEOFAPPLICATION | ODMADOCID | PAGES | PARAGRAPHS | REVISIONNUMBER| SECURITY | SUBJECT | TEMPLATE | TITLE | TOTALEDITINGTIME | WORDS

Description: Retrieves the indicated document information. For some combinations of DOCPROPERTY and docprop-category, there is an equivalent field, in which case, the description for the combination can be obtained from that field. For those combinations not having an equivalent field, the description is shown directly. When used directly, some of the equivalent fields allow the value of the designated property to be changed. However, when the corresponding DOCPROPERTY field is used, such values shall not be changed. This is indicated in the following table by "Read-only operation."

docprop-category

Corresponding Field

Description

AUTHOR

AUTHOR (§2.16.5.4)

Read-only operation.

BYTES

FILESIZE (§2.16.5.24)

CATEGORY

No equivalent

The contents of the <Category> element of the Core File Properties part.

CHARACTERS

NUMCHARS (§2.16.5.48)

CHARACTERSWITHSPACES

No equivalent

Like NUMCHARS, but includes all white space characters as well.

COMMENTS

COMMENTS (§2.16.5.11)

Read-only operation.

COMPANY

No equivalent

The contents of the <Company> element of the Application-Defined File Properties part.

CREATETIME

CREATEDATE (§2.16.5.16)

HYPERLINKBASE

No equivalent

The contents of the <HyperlinkBase> element of the Application-Defined File Properties part.

KEYWORDS

No equivalent

The contents of the <Keywords> element of the Core File Properties part.

LASTPRINTED

PRINTDATE (§2.16.5.54)

LASTSAVEDBY

LASTSAVEDBY (§2.16.5.38)

LASTSAVEDTIME

SAVEDATE (§2.16.5.60)

LINES

No equivalent

The contents of the <Lines> element of the Application-Defined File Properties part.

MANAGER

No equivalent

The contents of the <Manager> element of the Application-Defined File Properties part.

NAMEOFAPPLICATION

No equivalent

The contents of the <Application> element of the Application-Defined File Properties part.

ODMADOCID

PAGES

NUMPAGES (§2.16.5.49)

PARAGRAPHS

No equivalent

The contents of the <Paragraphs> element of the Application-Defined File Properties part.

REVISIONNUMBER

REVNUM (§2.16.5.59)

SECURITY

No equivalent

The contents of the <DocSecurity> element of the Application-Defined File Properties part.

SUBJECT

SUBJECT (§2.16.5.67)

Read-only operation.

TEMPLATE

TEMPLATE (§2.16.5.71)

TITLE

TITLE (§2.16.5.73)

Read-only operation.

TOTALEDITINGTIME

EDITTIME (§2.16.5.21)

WORDS

No equivalent

The contents of the <Words> element of the Application-Defined File Properties part.

Field Value: The indicated document information.