LoadFlags enumeration
The LoadFlags enumerated type is used to construct the flags parameter to the openDocument method by ORing any of the following options:
The LoadFlags enumeration has the following constants of type int.
OPEN_RDONLY = 0x0001
Open for read only and do not lock the underlying file. If this is not set, the underlying file will be locked if possible and the document will be read-only if no lock was acquired.
The “checked out” status of CMS Objects will not be affected.
OPEN_DOCRDWR = 0x0002
Open for writing and do not lock the underlying file. The document will be modifiable even though the underlying file is not locked.
If the document was already open in memory, this will additionally attempt to lock the underlying file.
The “checked out” status of CMS Objects will not be affected.
OPEN_NLOCK = 0x0004
Do not lock the underlying file. Overrides all other flags which might acquire a file lock. The resulting document will not be modifiable unless OPEN_DOCRDWR is also given.
The “checked out” status of CMS Objects will not be affected.
OPEN_CC = 0x0008
Perform a completeness check when reading the SGML file. This option is ignored for XML documents.
OPEN_NOCC = 0x0010
Suppress the completeness check when reading the SGML file. This option is ignored for XML documents. OPEN_NOCC is the default option for SGML documents saved by Arbortext Editor and Arbortext Publishing Engine.
OPEN_NOMSGS = 0x0020
Do not display any parser error messages in a message window. Instead, suppress all warnings and errors.
OPEN_FORCEDT = 0x0040
Use the document type specified by pubId and sysId to parse the SGML or XML file instead of the document type specified in the file itself.
OPEN_HELPWIN = 0x0080
Open a help document. (Used internally by Arbortext Editor and Arbortext Publishing Engine)
OPEN_XML = 0x0100
Open the document as an XML document even if it does not start with the XML version processing instruction. If not specified, the document is loaded as an SGML document unless the document starts with the XML version header.
OPEN_NOSTYLE = 0x0200
Open the document without loading a style sheet.
OPEN_NODTPROMPT = 0x0400
Do not prompt the user if the document type associated with the document instance does not exist or is not compiled. Instead, return null.
OPEN_COMPARE = 0x2000
Open as a specially-treated compare document. (Used internally byArbortext Editor and Arbortext Publishing Engine.)
OPEN_RECTABLES = 0x4000
Cause the table editor to recognize tables immediately after opening the document. By default, table objects are not created until the document is displayed in a window.
OPEN_EDITINIT = 0x8000
Process initialization files immediately after opening the document. This includes sourcing the associated document type instance files ( instance.acl, instance.js, and instance.vbs) and the document command files (docname .acl, docname.js, and docname .vbs). By default, these files are not processed until the document is displayed in a window.
OPEN_NEW_DOC = 0x10000
Treat the document as if it were created using the New dialog. In this case, the path name is set to null and the document name is of the form DocumentN.
OPEN_RECOVERY_PROMPT = 0x20000
Specifies that if an autosave or recovery file exists for the document, the user should be prompted to select the document to open.
OPEN_NAMESPACE_URI = 0x40000
Specifies that the pubId parameter is actually a namespace URI instead of a public identifier. If OPEN_FORCEDT is also specified, then the namespace URI is used to locate the XML schema to parse the document.
OPEN_FREEFORM = 0x80000
Open the document in free form mode, ignoring the document type specified in the file or by the public identifier pubId and system identifier sysId parameters.
OPEN_PARSE_STRING = 0x200000
Specifies that the path name parameter path is actually a string to parse instead of a file to open. If the string does not contain a DOCTYPE declaration then the pubId and or sysId parameters must be given so the desired document type is used to parse the string or else OPEN_FREEFORM should be specified. If the string contains XML markup but does not start with an XML declaration then OPEN_XML must also be specified.