getSummaryInformationProperties and getDocumentSummaryInformationProperties return singleton PropertyIDMaps. An application that wants to extend these maps
should treat them as unmodifiable, copy them and modify the
copies.
Trying to modify the map directly will cause exceptions
UnsupportedOperationException to be thrown.
| Modifier and Type | Field and Description |
|---|---|
| private static final Object[][] | |
| private static PropertyIDMap | documentSummaryInformationProperties
Contains the summary information property ID values and associated strings. |
| private static final Object[][] | |
| private static PropertyIDMap | fallbackProperties
Contains the fallback property ID values and associated strings. |
| private final Map | |
| public static final int | PID_APPNAME
ID of the property that denotes the application that created the document |
| public static final int | PID_AUTHOR
ID of the property that denotes the document's author |
| public static final int | PID_BEHAVIOUR
The Behavior property, if present, MUST have the property identifier 0x80000003, MUST NOT have a property name, and MUST have type VT_UI4 (0x0013). |
| public static final int | PID_BYTECOUNT
Number of bytes. |
| public static final int | PID_CATEGORY
The entry is a string denoting the category the file belongs to, e.g. review, memo, etc. This is useful to find documents of same type. |
| public static final int | PID_CCHWITHSPACES
The entry specifies an estimate of the number of characters in the document, including whitespace, as an integer |
| public static final int | PID_CHARCOUNT
ID of the property that denotes the number of characters in the document |
| public static final int | PID_CODEPAGE
The entry denotes a code page. |
| public static final int | PID_COMMENTS
ID of the property that denotes the document's comments |
| public static final int | PID_COMPANY
This entry contains the company name. |
| public static final int | PID_CONTENTSTATUS
This entry contains a string of the document status. |
| public static final int | PID_CONTENTTYPE
This entry contains a string of the content type of the file. |
| public static final int | PID_CREATE_DTM
ID of the property that denotes the date and time the document was created. |
| public static final int | PID_DICTIONARY
The entry is a dictionary. |
| public static final int | PID_DIGSIG
This entry contains the VBA digital signature for the VBA project embedded in the document. |
| public static final int | PID_DOCPARTS
This entry contains the names of document parts (word: names of the documents in the master document, excel: sheet names, power point: slide titles, binder: document names). |
| public static final int | PID_DOCVERSION
This entry contains a string of the document version, but normally should be empty |
| public static final int | PID_EDITTIME
ID of the property that denotes the document's edit time |
| public static final int | PID_HEADINGPAIR
This entry denotes an internally used property. |
| public static final int | PID_HIDDENCOUNT
Number of hidden slides. |
| public static final int | PID_HYPERLINKSCHANGED
This entry contains a boolean which marks if the User Defined Property Set has been updated outside of the Application, if so the hyperlinks should be updated on document load. |
| public static final int | PID_KEYWORDS
ID of the property that denotes the document's keywords |
| public static final int | PID_LANGUAGE
This entry contains a string of the document language, but normally should be empty. |
| public static final int | PID_LASTAUTHOR
ID of the property that denotes the document's last author |
| public static final int | PID_LASTPRINTED
ID of the property that denotes the date and time the document was last printed |
| public static final int | PID_LASTSAVE_DTM
ID of the property that denotes the date and time the document was saved |
| public static final int | PID_LINECOUNT
Number of lines. |
| public static final int | PID_LINKSDIRTY
If this entry is -1 the links are dirty and should be re-evaluated. |
| public static final int | PID_LOCALE
The Locale property, if present, MUST have the property identifier 0x80000000, MUST NOT have a property name, and MUST have type VT_UI4 (0x0013). |
| public static final int | PID_MANAGER
This entry contains the name of the project manager. |
| public static final int | PID_MAX
The highest well-known property ID. Applications are free to use higher values for custom purposes. |
| public static final int | PID_MMCLIPCOUNT
Number of multimedia clips, e.g. sound or video. |
| public static final int | PID_NOTECOUNT
Number of slides with notes. |
| public static final int | PID_PAGECOUNT
ID of the property that denotes the number of pages in the document |
| public static final int | PID_PARCOUNT
Number of paragraphs. |
| public static final int | PID_PRESFORMAT
Target format for power point presentation, e.g. 35mm, printer, video etc. |
| public static final int | PID_REVNUMBER
ID of the property that denotes the document's revision number |
| public static final int | PID_SCALE
This entry is set to -1 when scaling of the thumbnail is desired. |
| public static final int | PID_SECURITY
ID of the property that denotes whether read/write access to the document is allowed or whether is should be opened as read-only. |
| public static final int | PID_SLIDECOUNT
Number of slides in a power point presentation. |
| public static final int | PID_SUBJECT
ID of the property that denotes the document's subject |
| public static final int | PID_TEMPLATE
ID of the property that denotes the document's template |
| public static final int | PID_THUMBNAIL
ID of the property that denotes the document's thumbnail |
| public static final int | PID_TITLE
ID of the property that denotes the document's title |
| public static final int | PID_VERSION
This entry contains the version of the Application which wrote the Property set, stored with the two high order bytes having the major version number, and the two low order bytes the minor version number. |
| public static final int | PID_WORDCOUNT
ID of the property that denotes the number of words in the document |
| private static final Object[][] | |
| private static PropertyIDMap | summaryInformationProperties
Contains the summary information property ID values and associated strings. |
| public static final String | UNDEFINED
A property without a known name is described by this string. |
| Access | Constructor and Description |
|---|---|
| private | PropertyIDMap(Object[][]
an array of key/value pairs via nested Object[2] arrays idValues)Creates a |
| Modifier and Type | Method and Description |
|---|---|
| public void | clear()
Implements java. Removes all of the mappings from this map (optional operation). |
| public boolean | containsKey(Object
key whose presence in this map is to be tested key)Implements java. Returns |
| public boolean | containsValue(Object
value whose presence in this map is to be tested value)Implements java. Returns |
| public Set | entrySet()
Implements java. Returns a |
| public String | get(Object
the key whose associated value is to be returned key)Implements java. Returns the value to which the specified key is mapped,
or |
| public static synchronized PropertyIDMap | Returns: The Document Summary Information properties singleton.
|
| public static synchronized PropertyIDMap | Returns: the resulting property mapReturns a property map, which is only used as a fallback, i.e. if available, the correct map
for |
| public static synchronized PropertyIDMap | |
| public boolean | |
| public Set | |
| public static void | |
| public String | put(Long
key with which the specified value is to be associated key, String value to be associated with the specified key value)Implements java. Associates the specified value with the specified key in this map (optional operation). |
| public void | putAll(Map<? extends Long, ? extends String>
mappings to be stored in this map m)Implements java. Copies all of the mappings from the specified map to this map (optional operation). |
| public String | remove(Object
key whose mapping is to be removed from the map key)Implements java. Removes the mapping for a key from this map if it is present (optional operation). |
| public int | |
| public Collection | values()
Implements java. Returns a |
| documentSummaryInformationIdValues | back to summary |
|---|---|
| private static final Object[][] documentSummaryInformationIdValues | |
| documentSummaryInformationProperties | back to summary |
|---|---|
| private static PropertyIDMap documentSummaryInformationProperties Contains the summary information property ID values and associated strings. See the overall HPSF documentation for details! | |
| fallbackIdValues | back to summary |
|---|---|
| private static final Object[][] fallbackIdValues | |
| fallbackProperties | back to summary |
|---|---|
| private static PropertyIDMap fallbackProperties Contains the fallback property ID values and associated strings. This is only used for lookups and not for initializing a property set | |
| idMap | back to summary |
|---|---|
| private final Map<Long, String> idMap | |
| PID_APPNAME | back to summary |
|---|---|
| public static final int PID_APPNAME ID of the property that denotes the application that created the document | |
| PID_AUTHOR | back to summary |
|---|---|
| public static final int PID_AUTHOR ID of the property that denotes the document's author | |
| PID_BEHAVIOUR | back to summary |
|---|---|
| public static final int PID_BEHAVIOUR The Behavior property, if present, MUST have the property identifier 0x80000003, MUST NOT have a property name, and MUST have type VT_UI4 (0x0013). A version 0 property set, indicated by the value 0x0000 for the Version field of the PropertySetStream packet, MUST NOT have a Behavior property. If the Behavior property is present, it MUST have one of the following values.
| |
| PID_BYTECOUNT | back to summary |
|---|---|
| public static final int PID_BYTECOUNT Number of bytes. | |
| PID_CATEGORY | back to summary |
|---|---|
| public static final int PID_CATEGORY The entry is a string denoting the category the file belongs to, e.g. review, memo, etc. This is useful to find documents of same type. | |
| PID_CCHWITHSPACES | back to summary |
|---|---|
| public static final int PID_CCHWITHSPACES The entry specifies an estimate of the number of characters in the document, including whitespace, as an integer | |
| PID_CHARCOUNT | back to summary |
|---|---|
| public static final int PID_CHARCOUNT ID of the property that denotes the number of characters in the document | |
| PID_CODEPAGE | back to summary |
|---|---|
| public static final int PID_CODEPAGE The entry denotes a code page. | |
| PID_COMMENTS | back to summary |
|---|---|
| public static final int PID_COMMENTS ID of the property that denotes the document's comments | |
| PID_COMPANY | back to summary |
|---|---|
| public static final int PID_COMPANY This entry contains the company name. | |
| PID_CONTENTSTATUS | back to summary |
|---|---|
| public static final int PID_CONTENTSTATUS This entry contains a string of the document status. | |
| PID_CONTENTTYPE | back to summary |
|---|---|
| public static final int PID_CONTENTTYPE This entry contains a string of the content type of the file. | |
| PID_CREATE_DTM | back to summary |
|---|---|
| public static final int PID_CREATE_DTM ID of the property that denotes the date and time the document was created. | |
| PID_DICTIONARY | back to summary |
|---|---|
| public static final int PID_DICTIONARY The entry is a dictionary. | |
| PID_DIGSIG | back to summary |
|---|---|
| public static final int PID_DIGSIG This entry contains the VBA digital signature for the VBA project embedded in the document. | |
| PID_DOCPARTS | back to summary |
|---|---|
| public static final int PID_DOCPARTS This entry contains the names of document parts (word: names of the documents in the master document, excel: sheet names, power point: slide titles, binder: document names). | |
| PID_DOCVERSION | back to summary |
|---|---|
| public static final int PID_DOCVERSION This entry contains a string of the document version, but normally should be empty | |
| PID_EDITTIME | back to summary |
|---|---|
| public static final int PID_EDITTIME ID of the property that denotes the document's edit time | |
| PID_HEADINGPAIR | back to summary |
|---|---|
| public static final int PID_HEADINGPAIR This entry denotes an internally used property. It is a vector of variants consisting of pairs of a string (VT_LPSTR) and a number (VT_I4). The string is a heading name, and the number tells how many document parts are under that heading. | |
| PID_HIDDENCOUNT | back to summary |
|---|---|
| public static final int PID_HIDDENCOUNT Number of hidden slides. | |
| PID_HYPERLINKSCHANGED | back to summary |
|---|---|
| public static final int PID_HYPERLINKSCHANGED This entry contains a boolean which marks if the User Defined Property Set has been updated outside of the Application, if so the hyperlinks should be updated on document load. | |
| PID_KEYWORDS | back to summary |
|---|---|
| public static final int PID_KEYWORDS ID of the property that denotes the document's keywords | |
| PID_LANGUAGE | back to summary |
|---|---|
| public static final int PID_LANGUAGE This entry contains a string of the document language, but normally should be empty. | |
| PID_LASTAUTHOR | back to summary |
|---|---|
| public static final int PID_LASTAUTHOR ID of the property that denotes the document's last author | |
| PID_LASTPRINTED | back to summary |
|---|---|
| public static final int PID_LASTPRINTED ID of the property that denotes the date and time the document was last printed | |
| PID_LASTSAVE_DTM | back to summary |
|---|---|
| public static final int PID_LASTSAVE_DTM ID of the property that denotes the date and time the document was saved | |
| PID_LINECOUNT | back to summary |
|---|---|
| public static final int PID_LINECOUNT Number of lines. | |
| PID_LINKSDIRTY | back to summary |
|---|---|
| public static final int PID_LINKSDIRTY If this entry is -1 the links are dirty and should be re-evaluated. | |
| PID_LOCALE | back to summary |
|---|---|
| public static final int PID_LOCALE The Locale property, if present, MUST have the property identifier 0x80000000, MUST NOT have a property name, and MUST have type VT_UI4 (0x0013). If present, its value MUST be a valid language code identifier as specified in [MS-LCID]. Its value is selected in an implementation-specific manner. | |
| PID_MANAGER | back to summary |
|---|---|
| public static final int PID_MANAGER This entry contains the name of the project manager. | |
| PID_MAX | back to summary |
|---|---|
| public static final int PID_MAX The highest well-known property ID. Applications are free to use higher values for custom purposes. (This value is based on Office 12, earlier versions of Office had lower values) | |
| PID_MMCLIPCOUNT | back to summary |
|---|---|
| public static final int PID_MMCLIPCOUNT Number of multimedia clips, e.g. sound or video. | |
| PID_NOTECOUNT | back to summary |
|---|---|
| public static final int PID_NOTECOUNT Number of slides with notes. | |
| PID_PAGECOUNT | back to summary |
|---|---|
| public static final int PID_PAGECOUNT ID of the property that denotes the number of pages in the document | |
| PID_PARCOUNT | back to summary |
|---|---|
| public static final int PID_PARCOUNT Number of paragraphs. | |
| PID_PRESFORMAT | back to summary |
|---|---|
| public static final int PID_PRESFORMAT Target format for power point presentation, e.g. 35mm, printer, video etc. | |
| PID_REVNUMBER | back to summary |
|---|---|
| public static final int PID_REVNUMBER ID of the property that denotes the document's revision number | |
| PID_SCALE | back to summary |
|---|---|
| public static final int PID_SCALE This entry is set to -1 when scaling of the thumbnail is desired. Otherwise the thumbnail should be cropped. | |
| PID_SECURITY | back to summary | ||||||||
|---|---|---|---|---|---|---|---|---|---|
| public static final int PID_SECURITY ID of the property that denotes whether read/write access to the document is allowed or whether is should be opened as read-only. It can have the following values:
| |||||||||
| PID_SLIDECOUNT | back to summary |
|---|---|
| public static final int PID_SLIDECOUNT Number of slides in a power point presentation. | |
| PID_SUBJECT | back to summary |
|---|---|
| public static final int PID_SUBJECT ID of the property that denotes the document's subject | |
| PID_TEMPLATE | back to summary |
|---|---|
| public static final int PID_TEMPLATE ID of the property that denotes the document's template | |
| PID_THUMBNAIL | back to summary |
|---|---|
| public static final int PID_THUMBNAIL ID of the property that denotes the document's thumbnail | |
| PID_TITLE | back to summary |
|---|---|
| public static final int PID_TITLE ID of the property that denotes the document's title | |
| PID_VERSION | back to summary |
|---|---|
| public static final int PID_VERSION This entry contains the version of the Application which wrote the Property set, stored with the two high order bytes having the major version number, and the two low order bytes the minor version number. | |
| PID_WORDCOUNT | back to summary |
|---|---|
| public static final int PID_WORDCOUNT ID of the property that denotes the number of words in the document | |
| summaryInformationIdValues | back to summary |
|---|---|
| private static final Object[][] summaryInformationIdValues | |
| summaryInformationProperties | back to summary |
|---|---|
| private static PropertyIDMap summaryInformationProperties Contains the summary information property ID values and associated strings. See the overall HPSF documentation for details! | |
| UNDEFINED | back to summary |
|---|---|
| public static final String UNDEFINED A property without a known name is described by this string. | |
| PropertyIDMap | back to summary |
|---|---|
| private PropertyIDMap(Object[][] idValues) Creates a
| |
| clear | back to summary |
|---|---|
| public void clear() Implements java. Doc from java. Removes all of the mappings from this map (optional operation). The map will be empty after this call returns.
| |
| containsKey | back to summary |
|---|---|
| public boolean containsKey(Object key) Implements java. Doc from java. Returns | |
| containsValue | back to summary |
|---|---|
| public boolean containsValue(Object value) Implements java. Doc from java. Returns | |
| entrySet | back to summary |
|---|---|
| public Set Implements java. Doc from java. Returns a | |
| get | back to summary |
|---|---|
| public String get(Object key) Implements java. Doc from java. Returns the value to which the specified key is mapped,
or More formally, if this map contains a mapping from a key
If this map permits null values, then a return value of
| |
| getDocumentSummaryInformationProperties | back to summary |
|---|---|
public static synchronized PropertyIDMap getDocumentSummaryInformationProperties()
| |
| getFallbackProperties | back to summary |
|---|---|
| public static synchronized PropertyIDMap getFallbackProperties() Returns a property map, which is only used as a fallback, i.e. if available, the correct map
for
| |
| getSummaryInformationProperties | back to summary |
|---|---|
public static synchronized PropertyIDMap getSummaryInformationProperties()
| |
| isEmpty | back to summary |
|---|---|
| public boolean isEmpty() Implements java. Doc from java. Returns
| |
| keySet | back to summary |
|---|---|
| public Set Implements java. Doc from java. Returns a | |
| main | back to summary |
|---|---|
| public static void main(final String[] args) For the most basic testing.
| |
| put | back to summary |
|---|---|
| public String put(Long key, String value) Implements java. Doc from java. Associates the specified value with the specified key in this map
(optional operation). If the map previously contained a mapping for
the key, the old value is replaced by the specified value. (A map
| |
| putAll | back to summary |
|---|---|
| public void putAll(Map<? extends Long, ? extends String> m) Implements java. Doc from java. Copies all of the mappings from the specified map to this map
(optional operation). The effect of this call is equivalent to that
of calling | |
| remove | back to summary |
|---|---|
| public String remove(Object key) Implements java. Doc from java. Removes the mapping for a key from this map if it is present
(optional operation). More formally, if this map contains a mapping
from key Returns the value to which this map previously associated the key,
or If this map permits null values, then a return value of
The map will not contain a mapping for the specified key once the call returns. | |
| size | back to summary |
|---|---|
| public int size() Implements java. Doc from java. Returns the number of key-value mappings in this map. If the
map contains more than
| |
| values | back to summary |
|---|---|
| public Collection Implements java. Doc from java. Returns a
| |