Overview Module Use Devguide Index
Constants Constants' Details

:: com :: sun :: star :: ucb ::

constants group OpenMode
Description
These are the possible values for OpenCommandArgument::Mode.
Constants
ALL open a folder, include all children in result set (documents and folders).  
FOLDERS open a folder, include only children, that are folders, in result set.  
DOCUMENTS open a folder, include only children, that are documents, in result set.  
DOCUMENT open a document. There are no special requirements for data access sharing.  
DOCUMENT_SHARE_DENY_NONE open a document. Allow shared read and write access.  
DOCUMENT_SHARE_DENY_WRITE open a document. Deny shared write access.  
Constants' Details
ALL
const short ALL = 0;
Description
open a folder, include all children in result set (documents and folders).
FOLDERS
const short FOLDERS = 1;
Description
open a folder, include only children, that are folders, in result set.
DOCUMENTS
const short DOCUMENTS = 3;
Description
open a folder, include only children, that are documents, in result set.
DOCUMENT
const short DOCUMENT = 2;
Description
open a document. There are no special requirements for data access sharing.

Note: There must be a data sink supplied in the OpenCommandArgument struct, if this value is set. This sink will be used by the content implementation to supply the document data.

DOCUMENT_SHARE_DENY_NONE
const short DOCUMENT_SHARE_DENY_NONE = 4;
Description
open a document. Allow shared read and write access.

Note: There must be a data sink supplied in the OpenCommandArgument struct, if this value is set. This sink will be used by the content implementation to supply the document data.

DOCUMENT_SHARE_DENY_WRITE
const short DOCUMENT_SHARE_DENY_WRITE = 5;
Description
open a document. Deny shared write access.

Note: There must be a data sink supplied in the OpenCommandArgument struct, if this value is set. This sink will be used by the content implementation to supply the document data.

Top of Page

Copyright © 2012, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.