Report

Namespace: PP.Prx.

Inheritance Hierarchy

PP.Object

PP.Mb.Descriptor

PP.Mb.Object

PP.Prx.Report

Description

The Report class implements the regular report model.

Syntax

PP.initClass(PP.Prx.Report, PP.Mb.Object, "Report");

Properties

  Property name Brief description
ActiveSheetKey The ActiveSheetKey property determines the key for the opened report sheet.
Control The Control property determines the control model for the regular report.
EnabledRanges The EnabledRanges property determines ranges available for editing.
ForceShowControls

The ForceShowControls property determines whether the Controls panel is displayed in the report without controls.

IsDataChanged

The IsDataChanged property determines whether the table cells contents of the regular report is changed.

Params

The Params property defines regular report parameters.

Methods

  Method name Brief description
getActiveSheetIndex The getActiveSheetIndex method returns an index of the opened report sheet.
getControls The getControls method gets the list of controls for the specified report sheet.
getSheetIndexByKey The getSheetIndexByKey method returns the sheet index by the key according to the hidden sheets.
getSheets

The getSheets method returns the array of report sheets descriptions.

getTabId The getTabId method returns the moniker string for the table of the active sheet.
getDisplayTabs The getDisplayTabs method returns whether sheet tabs are displayed.
isAnyControlVisible

The isAnyControlVisible method determines the availability of controls for the selected report sheet.

isAnyTableSheetExists

The isAnyTableSheetExists method determines whether the tables are in the report.

Properties inherited from the class Object

  Property name Brief description
Metabase The Metabase property determines a repository that stores the object.
Names The Names property determines a collection of the object names for different languages.
OdId The OdId property determines a string of repository object moniker.

Params

The Params property determines a collection of the parameters for the repository object.
PPService The PPService property determines a service for working with a repository object.
ReadOnly The ReadOnly property determines whether it is possible to edit repository object.
ShareUrl The ShareUrl property determines URL of repository object.

Methods inherited from the class Object

  Method name Brief description
getIsOpened The getIsOpened method returns object opening checking result.
getRights The getRights method returns effective access permissions of the object.

Properties inherited from the class Descriptor

  Property name Brief description
Class The Class property determines a repository object class.
HasChildren The HasChildren property returns whether there are child objects.
IsLink The IsLink property returns whether this object is in another repository.
IsShortcut The IsShortcut property returns whether this object is a shortcut to other repository object.
Key The Key property determines a repository object key.
Metadata The Metadata property determines object metadata.
Name The Name property determines object name.

ParentKey

The ParentKey property determines parent object key.
TimeStamp The TimeStamp property determines date and time of the last changing of the repository object.
Visible The Visible property returns whether a repository object is visible.

Methods inherited from the class Descriptor

  Method name Brief description
getState The getState method returns object descriptor metadata: values of all properties of the Descriptor class.

Properties inherited from the class Object

  Property name Brief description

Id

The Id property determines a repository object identifier.

Methods inherited from the class Object

  Method name Brief description
clone The clone method creates an object copy.
dispose The dispose method deletes the component.
getHashCode The getHashCode method returns hash code of repository object.
getId The getId method returns repository object identifier.
getSettings The getSettings method returns repository object settings.
getTypeName The getTypeName method returns the name of the object type without the namespace, to which it belongs.
isEqual The isEqual method determines whether the specified object is equal to the current repository object.
isLive The isLive method determines validity of repository object.
removeAllEvents The removeAllEvents method removes all object event handlers by the specified context.
setId The setId method determines a repository object identifier.
setSettings The setSettings method determines repository object settings.
defineProps The defineProps method creates get and set methods from name array for the specified class.
keys The keys method returns array of methods and properties names for the specified object.

See also:

PP.Prx