Reference for Document

A document retrieved by using env.getBqyDocument() contains these properties.

Property

Description

DesignPassword

Password required to enter Design mode

DocumentPassword

Password required to open the document

EncryptedScripts

Determines whether scripts in the document are encrypted

EventScripts

Document-level scripts

Name

Document name

Path

Path to the document

Root_MyDocument

Root.MyDocument node

Root_MyResources

Root.MyResources node (or null if the document does not include Resource Manager data)

Sections

All sections contained in the document

Type

Retrieve the runtime class name

Unicode

Determines whether the document string content is in Unicode or code page format

The same document also contains these methods.

Method

Description

copy()

Copy the specified section to the document, rename it, if necessary, to avoid duplicates

getChartSections()

Retrieve a list of all chart sections

getChildrenWithRuntimeClass()

Retrieve all child nodes with a specified RuntimeClassName

getCodePage()

Retrieve the code page used by the document

getDashboardSections()

Retrieve a list of all the dashboard sections

getInitialTCSection()

Retrieve the home section identifier

getPivotSections()

Retrieve a list of all pivot sections

getQuerySections()

Retrieve a list of all query sections

getResultsSections()

Retrieve a list of all results sections

getSource()

Get the path to the Interactive Reporting document from which this document was loaded

getTableSections()

Retrieve a list of all table sections

isBQYPasswordProtected()

Determine whether the document has a password

isBQYProcessable()

Determine whether the document has at least one processable section

load()

Load a document from an Interactive Reporting document on disk

optimizeImages()

Optimize all of the Resource Manager images to remove duplicates

save()

Save the document to an Interactive Reporting document on disk

sectionOCEPairInfos()

Retrieve a list of all the document OCE mappings

setCodePage()

Set the document code page

setEndianness()

Set whether the document should be stored as big- or small-endian

setHeader()

Set the document header

setSource()

Set the path to the source from which this document was loaded