businessobjects sdk object model diagrams

31
Part Number: 254-10-550-01 Edition: 3 Version 5.5 Windows BusinessObjects SDK Object Model Diagrams Copyright © Business Objects 2002. All rights reserved. Portions © Copyright 1996, Microsoft Corporation. All rights reserved. Printed in France.

Upload: kayak007

Post on 07-Nov-2014

89 views

Category:

Documents


7 download

TRANSCRIPT

Page 1: BusinessObjects SDK Object Model Diagrams

Part Number: 254-10-550-01

Edition: 3

Version 5.5

Windows

BusinessObjects SDKObject Model Diagrams

Copyright © Business Objects 2002. All rights reserved.Portions © Copyright 1996, Microsoft Corporation. All rights reserved.

Printed in France.

Page 2: BusinessObjects SDK Object Model Diagrams
Page 3: BusinessObjects SDK Object Model Diagrams

BusinessObjects Object ModelCoreDocumentsCommandBarsUniversesData ProvidersSend To Broadcast AgentReports

VBE 5.0 Object ModelCoreCommand BarsCode Panes and VB Components

DpVBAInterface Object ModelCore

Designer Object ModelCoreConnections and NetworkLayersUniverseDomains and UsersObjectStrategies and CandidateClassesJoinStrategies and CandidateJoinsTableStrategies and DBTablesClasses and ObjectsTables, Joins and ContextsCustomHierarchies, DefaultHierarchies, Qualifiers and OwnersLinkedUniverses, SQLOption and ControlOption

Report Viewer Object ModelCore

Contents

1

27

26

25

24

2322

2120

191817

16

15

1413

1211

109

8

76

54

32

Page 4: BusinessObjects SDK Object Model Diagrams

BusinessObjects Object Model - Overview1

Application

SecurityPrompts

Document

CmdBar

Variable

DataProvider

Query

SortCondition

Result Window

DocAgentOption

Column

Window

Report

Universe

ListofValues

Class

Object

CmdBarControl

Variable

DocumentVariable

SectionStructure

ReportStructureItem

Pivot

VBE

. . .

Daily

Every

Hourly

Monthly

Weekly

UserDefined

FileWatcher

PredefinedCondition

Legend

Object and Collection

Object Only

Page 5: BusinessObjects SDK Object Model Diagrams

Application As Application (R)Parent As Object (R)

ActiveDocument As Document (R)ActiveReport As Report (R)

BreakOnVBAError As Boolean (R/W)ClipBoard As ClipBoard (R)CmdBars As CmdBars (R)

Documents As Documents (R)ExchangeDomain As String (R/W)

ExchangeMode As BoExchangeMode (R/W)Interactive As Boolean (R/W)

Name As String (R/W)Universes As Universes (R)Variables As Variables (R)

VBE As VBE (R)Version As String (R)

Visible As Boolean (R/W)Window As Window (R)

Function GetVersion((ByRef) Major As Integer, (ByRef) Minor AsInteger, (ByRef) Maintenance As Integer) As Boolean (R)

Sub ExecuteMacro(MacroName As String)Function GetInstallDirectory(DirectoryID As BoDirectoryID) As String

Function LoginAs([User As String], [Pass As String], [Offline AsBoolean], [RepositoryName As String]) As Boolean

Sub Quit()Sub ReceiveScript([Name as String])

Sub RegisterDPVBAProc(procName As String, friendlyName AsString, description As String)

Sub SetInstallDirectory(DirectoryID As BoDirectoryID, Path AsString, Temporary As Boolean)

Sub SetSecurityPrompt(UserName As String,UserPasswordvarName As String, UserPassword As String, DBNameAs String, DBPasswordVarName As String, DBPassword As String)Sub UnregisterDPVBAProc(procName As String, friendlyName As

String, description As String)

Event DOCUMENTACTIVATE (ByVal Doc As busobj.IDocument)Event DOCUMENTBEFOREREFRESH (ByVal Doc As busobj.IDocument,

Cancel As Boolean)Event DOCUMENTAFTERREFRESH (ByVal Doc As busobj.IDocument)Event DOCUMENTBEFORECLOSE (ByVal Doc As busobj.IDocument,

Cancel As Boolean)Event DOCUMENTBEFORESAVE (ByVal Doc As busobj.IDocument,

Cancel As Boolean)Event DOCUMENTDEACTIVATE (ByVal Doc As busobj.IDocument)

Event DOCUMENTOPEN (ByVal Doc As busobj.IDocument)Event NEWDOCUMENT (ByVal Doc As busobj.IDocument)

Application

Variables

Application As Application (R)Parent As Object (R)Count As Long (R)

Property Item(Index As Variant) As Variable

Function Add(Name As String) As Variable

Variable

Application As Application (R)Parent As Object (R)Name As String (R/W)Value As String (R/W)

IsUserPrompt As Boolean (R)PossibleValues As String (R)MultiValued As Boolean (R)

InterpretAs AsBoVariableInterpretAs (R/W)

Sub Delete()

Window

Application As Application (R)Parent As Object (R)Caption As String (R)

Height, Width,Top, Left As Long (R/W)State As BoWindowState (R/W)

Sub Activate()Sub Close()

BoVariableInterpretAs

boDateVariableboNumericVariableboStringVariable

BusinessObjects Object Model - Core

Legend

Collection

Object

Enum

Clipboard

Application As Application (R)Parent As Object (R)

Sub Clear()Function GetData([Format As Variant]) As StdPicture

Function GetFormat(Format As Long) As BooleanFunction GetText([Format As Variant]) As String

Sub SetData(Picture As StdPicture, [Format As Variant])Sub SetText(Str As String, [Format As Variant])

BoExchangeMode

boDocAgentModeboRepositoryModeboRepositoryModeNoOverwriteboUserMode

BoDirectoryID

boBusObjDirectoryboDocumentDirectoryboLocDataDirectoryboScriptsDirectoryboSharedDataDirectoryboTemplateDirectoryboUniverseDirectoryboTemporaryDirectory

BoClipboardFormat

boClipboardFormatBitmapboClipboardFormatMetafileboClipboardFormatText

2

Page 6: BusinessObjects SDK Object Model Diagrams

Document

Application As Application (R)Parent As Object (R)

Author As String (R/W)ActiveReport As Report (R)

AutoRefreshWhenOpening As Boolean (R/W)Comments As String (R/W)

DataProviders As DataProviders (R)DocAgentOption As DocAgentOption (R)

DocumentVariables As DocumentVariables (R)FullName As String (R)

Installed As BoInstallStatus (R/W)IsAddIn As Boolean (R/W)Keywords As String (R/W)LastPrintDate As String (R)LastSaveDate As String (R)

Name As String (R)PartialResults As Boolean (R)

Path As String (R)Reports As Reports (R)Saved As Boolean (R)

Subject As String (R/W)Title As String (R/W)

Variables As Variables (R)Windows As Windows (R)

Sub Activate()Sub Close([CloseOption As BoCloseOption])

Sub ConvertFromReportScript (FileName As String)Function Evaluate(Formula As String, [EvaluationMode

As BoEvaluationMode)Sub ExecuteMacro(MacroName As String)

Sub ExportAsPDF(fileName As String)Function ExportSheetsAsHtml(FileName As String,

[SheetsName As String], [Graphs As Boolean], [BordersAs Boolean], [Background As Boolean], [Foreground AsBoolean], [Font As Boolean], [FreeForm As Boolean],

[Frames As Boolean], [AutoRefreshTime As Long],[BusObjDoc As Boolean], [HtmlLayout As

boHTMLLayout]) As LongFunction GetSecurityPrompts() As SecurityPrompts

Sub PrintOut([PrinterName As String])Sub PrintDialog()

Sub Refresh()Sub Save()

Sub SaveAs([Name As String], [ForAllUsers AsBoolean])

Sub Send([User As String], [StoreGeneratedHTML AsBoolean], [HtmlLayout As BoHTMLLayout],[CategoryList As String, [ExchangeMode As

BoExchangeMode], [ExchangeDomain As String])

Event ACTIVATE()Event BEFORECLOSE(Cancel As Boolean)

Event BEFOREREFRESH(Cancel As Boolean)Event AFTERREFRESH()

Event BEFORESAVE(Cancel As Boolean)Event DEACTIVATE()

Event OPEN()

Documents

Application As Application (R)Parent As Object (R)Count As Long (R)

Property Item(Index As Variant) As Document

Function Add() As DocumentFunction Open([Name As String], [NoAutomaticRefresh As Boolean], [ReadOnlyAs Boolean], [Password As String], [WriteResPassword As String]) As Document

Sub Receive([Name As String], [DestDir As String])

BoCloseOption

boSaveIfModifiedboDontSaveboPromptUser

BoObjectQualification

boDetailboDimensionboMeasure

BoWindowState

boMaximizedboMinimizedboNormal

Variables

Application As Application (R)Parent As Object (R)Count As Long (R)

Property Item(Index As Variant)As Variable

Function Add(Name As String)As Variable

Variable

Application As Application (R)Parent As Object (R)Name As String (R/W)

InterpretAs AsBoVariableInterpretAs (R/W)

Value As Variant (R/W)IsUserPrompt As Boolean (R) PossibleValues As String (R)MultiValued As Boolean (R)

Sub Delete()

BusinessObjects Object Model - Documents

Windows

Application As Application (R)Parent As Object (R)Count As Long (R)

Property Item(Index as Variant)As Window

Window

Application As Application (R)Parent As Object (R)Caption As String (R)

Height, Width, Top, Left AsLong (R/W)

State As BoWindowState (R/W)

Sub Activate()Sub Close()

DocumentVariables

Application As Application (R)Parent As Object (R)Count As Long (R)

Property Item(Index As Variant)As DocumentVariable

Function Add(Formula AsString, [Name As String]) As

DocumentVariable

DocumentVariable

Application As Application (R)Parent As Object (R)Name As String (R/W)

Qualification AsBoObjectQualification (R/W)

Formula As String (R/W)IsDataProviderObject As

Boolean (R)Values(EvaluationMode As

BOEvaluationMode) As Variant(R)

Sub Delete()

Legend

Collection

Object

Enum

BoVariableInterpretAs

boDateVariableboNumericVariableboStringVariable

boHTMLLayout

boHTMLOnePageboHTMLSectionBySectionboHTMLBoth

SecurityPrompts

Application As Object (R)Parent As Object (R)Count As Long (R)

Function GetPrompt(Index AsLong, Title As String,UserName As String,

UserPasswordVarName AsString, DBName As String,DBPasswordVarName As

String) As Boolean

BoExchangeMode

boUserModeboRepositoryModeboRepositoryModeNoOverwriteboDocAgentMode

3

BoInstallStatus

boInstalledboInstalledAndLockedboNotInstalled

BoEvaluationMode

Bo41BehaviorBoAllValuesboUniqueValues

Page 7: BusinessObjects SDK Object Model Diagrams

BuiltInFace As Boolean (R)FaceID As Long (R/W)

Sub CopyFace()Sub PasteFace()

CmdBars

Application As Application (R)Parent As Object (R)Count As Long (R)

Property Item(Index As Variant) As CmdBar (R)ActiveMenuBar As CmdBar (R)

DisplayKeysInTooltips As Boolean (R/W)DisplayTooltips As Boolean (R/W)LargeButtons As Boolean (R/W)

Function Add(Name As String, Position As BoBarPosition)As CmdBar

CmdBar

Application As Application (R)Parent As Object (R)

BuiltIn As Boolean (R)Controls As CmdBarControls (R)

Enabled As Boolean (R/W)Name As String (R/W)

Position As BoBarPosition (R/W)Type As BoBarType (R)

Visible As Boolean (R/W)

Sub Delete()Sub ShowPopup([x As Variant],

[y As Variant])

CmdBarControls

Application As Application (R)Parent As Object (R)Count As Long (R)

Property Item(Index As Variant) As CmdBarControl (R)

Function Add(Type As BoControlType, [ID As Long],[Before As Long]) As CmdBarControl

CmdBarControl

Application As Application (R)Parent As Object (R)

BuiltIn As Boolean (R)Caption As String (R/W)

DescriptionText As String (R/W)ID As Long (R)

Index As Long (R)OnAction As String (R/W)

TooltipText As String (R/W)Type As BoControlType (R)

Sub Delete()Sub Execute()

*CmdBarButton

*CmdBarPopup

CmdBar As CmdBar (R)Controls As CmdBarControl (R)

BoBarPosition

boBarLeftboBarTopboBarRightboBarBottomboBarFloatingboBarPopup

BoBarType

boBarTypeNormalboBarTypeMenuBarboBarTypePopup

BoControlType

boControlButtonboControlPopup

BusinessObjects Object Model - CmdBars

Legend

Collection

Object

Enum

*These objects inherit all ofCmdBarControl’s properties and methods

4

Page 8: BusinessObjects SDK Object Model Diagrams

Universes

Application As Application(R)

Parent As Object (R)Count As Long (R)

Property Item(Index AsVariant, [RepositoryNameAs String]) As Universe (R)

Universe

Application As Application (R)Parent As Object (R)

Classes As Classes (R)LongName As String (R)ShortName As String (R)

DomainName As String (R)

Classes

Application AsApplication (R)

Parent As Object (R)Count As Long (R)

Property Item(Index AsVariant) As Class (R)

Class

Application As Application(R)

Parent As Object (R)Classes As Classes (R)

Description As String (R)Name As String (R)

Objects As Objects (R)PredefinedConditions AsPredefinedConditions (R)

Objects

Application As Object (R)Parent As Object (R)Count As Long (R)

Property Item(Index AsVariant) As Object (R)

Object

Application As Application (R)Parent As Object (R)

ListofValues As ListofValues (R)Name As String (R)

Description As String (R)Objects As Objects (R)

Qualification AsBoObjectQualification (R)

Type As BoObjectType (R)

PredefinedConditions

Application As Application (R)Parent As Object (R)Count As Long (R)

Property Item(Index AsVariant) As

PredefinedCondition (R)

PredefinedCondition

Application As Application (R)Parent As Object (R)

Description As String (R)Name As String (R)

ListofValues

Application AsApplication (R)

Parent As Object (R)*Values As Variant (R)

Sub Edit()Sub Purge()

Sub Refresh()

BoObjectQualification

boDetailboDimensionboMeasure

BoObjectType

boBlobCharacterObjectboBlobObjectboCharacterObjectboDateObjectboNullObjectboNumericObject

BusinessObjects Object Model - Universes

Legend

Collection

Object

Enum

*Returns an array containingthe list of values.

5

Page 9: BusinessObjects SDK Object Model Diagrams

Application As Application (R)Parent As Object (R)

Columns As Columns (R)IsEditable As Boolean (R/W)

IsRefreshable As Boolean (R/W)LastExecutionTime As String (R)

Name As String (R/W)MaxDuration As Long (R/W)MaxNbLines As Long (R/W)

NbCubes As Long (R)NbRowsFetched As Long (R)

Queries As Queries (R)SQL As String (R/W) *

Universe As Universe (R)UniverseName As String (R)

Sub ChangeUniverse(newUniverse AsUniverse)

Sub ConvertTo(Type AsBoConvertToType, CubeNb As Long,

[FileName As String])Sub ExportToRDBMS(ConnectionName

As String, ConnectionType AsBoConnectionType)

Sub Edit()Function GetType() As String

Sub Load()Sub Refresh()Sub Unload()

DataProviders

Application As Application (R)Parent As Object (R)Count As Long (R)

Property Item(Index AsVariant) As DataProvider

FunctionAddDPVBA(procName As

String) As DataProviderFunction AddQueryTechnique

(UniverseName As String,[UniverseDomainName AsString]) As DataProvider

DataProvider

Columns

Application As Application (R)Parent As Object (R)Count As Long (R)

Property Item(Index AsVariant) As Column (R)

Queries

Application As Application (R)Parent As Object (R)Count As Long (R)

Property Item(Index AsVariant) As Query (R)

DuplicateRows As Boolean(R/W)

DeleteTrailingBlanks AsBoolean (R/W)

ScopeOfAnalysis AsBoScopeOfAnalysis (R/W)

Sorts() As Sorts (R)

Function Add() As Query

Query

Application As Application (R)Parent As Object (R)

Conditions As Conditions (R)Name As String (R)

Operator As BoQueryOperator(R/W)

Results As Results (R)

Sorts

Application As Application (R)Parent As Object (R)Count As Long (R)

Property Item(Index As Long)As Sort

Function Add(Class As String,Object As String, Ascending As

Boolean) As SortSub Remove(Item As Long)

Sort

Application As Application (R)Parent As Object (R)Class As String (R)Object As String (R)

Ascending As Boolean (R)

Results

Application As Application (R)Parent As Object (R)Count As Long (R)

Property Item(Index As Long)As Result

Function Add(Class As String,Object As String) As Result

Sub Remove(Class As String,Object As String)

Sub RemoveByIndex(Index As Long)

Conditions

Application As Application (R)Parent As Object (R)Count As Long (R)

Property Item(Index As Long)As Condition (R)

Format As String (R/W)

Function Add(Class As String,ObjectOrCondition As String,

[Operator As String],[Operand1 As String],

[Operand1Type As String],[Operand2 As String],

[Operand2Type As String])As Condition

Sub Remove(Index As Long)

Condition

Application As Application (R)Parent As Object (R)Class As String (R)Level As Long (R)

Object As String (R)Property Operand(Index As

Long) As String (R)OperandCount As Long (R)

Property OperandType(IndexAs Long) As String (R)Operator As String (R)

Result

Application As Application (R)Parent As Object (R)Class As String (R)Object As String (R)

Column

Application As Application (R)Parent As Object (R)Count As Long (R)

Property Item(Index As Long) (R)Name As String (R)

Sub CustomSort(SortOrder As String)

BoConvertToType

boExpAsciiCSVboExpAsciiTabboExpDbaseboExpExcelboExpExcel97boExpLotus

BoQueryOperator

boOperatorIntersectionboOperatorMinusboOperatorNoneboOperatorUnion

BusinessObjects Object Model - Data Providers

* The SQL property in the DataProvider class isWritable only in the case of a Query Techniquedata provider

Legend

Collection

Object

Enum

BoScopeOfAnalysis

boOneLevelsDownboTwoLevelsDownboThreeLevelsDownboZeroLevelsDown

BoConnectionType

boPersonalConnectionboSharedConnection

6

Page 10: BusinessObjects SDK Object Model Diagrams

DocAgentOption

Application As Application (R)Parent As Object (R)

CategoryList As String (R/W)ContinueOnInvalidCategory As Boolean (R/W)

ContinueOnInvalidUser As Boolean (R/W)CustomScript As String (R/W)

DistributionFolder As String (R/W)Daily As Daily (R)

EndDate As Date (R/W)Every As Every (R)

FileWatcher As FileWatcher (R)Hourly As Hourly (R)

Monthly As Monthly (R)Overwrite As Boolean (R/W)Priority As BoPriority (R/W)Refresh As Boolean (R/W)

RefreshInTheNameOfRecipient As Boolean (R/W)ScheduleMode As BoScheduleMode (R/W)

Server As String (R/W)StartDate As Date (R/W)

Title As String (R/W)UserDefined As UserDefined (R)

Property Users(Index As Long) As String (R/W)Weekly As Weekly (R)

Function Send() As LongSub ResetToDefault()

Daily

Application As Application (R)Parent As Object (R)

Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday As Boolean (R/W)StartTime As Date (R/W)

WeekPeriodicity As Long (R/W)

Every

Application As Application (R)Parent As Object (R)Every As Long (R/W)

Day As BoDayDA (R/W)StartHour As Date (R/W)

MonthPeriodicity As Long (R/W)

Hourly

Application As Application (R)Parent As Object (R)

FromHour As Date (R/W)ToHour As Date (R/W)

MinutesAfterHour As Long (R/W)

Monthly

Application As Application (R)Parent As Object (R)

Day1, Day2, Day3, Day4, Day5, Day6, Day7, Day8, Day9, Day10, Day11, Day12,Day13, Day14, Day15, Day16, Day17, Day18, Day19, Day20, Day21, Day22,

Day23, Day24, Day25, Day26, Day27, Day28, Day29, Day30, Day31,LastDayOfMonth As Boolean (R/W)

StartTime As Date (R/W)

Weekly

Application As Application (R)Parent As Object (R)

StartDay As Long (R/W)StartTime As Date (R/W)

WeekPeriodicity As Long (R/W)

UserDefined

Application As Application (R)Parent As Object (R)Every As Long (R/W)

Unit As BoDayDA (R/W)

FileWatcher

Application As Application (R)Parent As Object (R)

FullFileName As String (R/W)FileWatcherOnly As Boolean (R/W)

DeleteFileOnCompletion As Boolean (R/W)

BoPriority

boPriorityHighboPriorityLowboPriorityNormal

BoScheduleMode

boDailyboEveryboHourlyboMonthlyboOnceboUserDefinedboWeekly

BoDayDA

boUserDefinedBusinessDaysboUserDefinedDaysboUserDefinedFridaysboUserDefinedHoursboUserDefinedMinutesboUserDefinedMondaysboUserDefinedSaturdaysboUserDefinedSundaysboUserDefinedThursdaysboUserDefinedTuesdaysboUserDefinedWednesdaysboUserDefinedWeekendDays

BusinessObjects Object Model - Send To Broadcast Agent

Legend

Collection

Object

Enum

7

Page 11: BusinessObjects SDK Object Model Diagrams

Name As String (R/W)Pivot As Pivot (R)

Reports

Application As Application (R)Parent As Object (R)Count As Long (R)

Property Item(Index As Variant)As Report (R)

FunctionCreateQuickReport([DPName

As Variant]) As ReportFunction Add() As Report

Report

Application As Application (R)Parent As Object (R)

GeneralSectionStructure AsSectionStructure (R)

Name As String (R/W)NumberOfPages As Long (R)

PageHeader As ReportStructureItems (R)PageFooter As ReportStructureItems (R)

DrillMode As Boolean (R)

Sub Activate()Sub AddComplexFilter(Variable As

Variant, Formula As String)Sub ApplyTemplate([FileName As

Variant], [StyleAndStructure As Boolean])Sub Delete()

Function Duplicate() As ReportFunction ExportAsHtml(FileName As

String, [Graphs As Boolean], [Borders AsBoolean], [Background As Boolean],[Foreground As Boolean], [Font AsBoolean], [FreeForm As Boolean],

[Frames As Boolean], [AutoRefreshTimeAs Long], [HtmlLayout As BoHtmlLayout])

As BooleanSub ExportAsPDF(fileName As String)Function ExportAsText(FileName As

String) As BooleanFunction ExportAsRtf(FileName As

String) As BooleanSub ForceCompute()

Sub PrintOut([PrinterName As String])Sub Reset()

SectionStructure

Application As Application (R)Parent As Object (R)

Header AsReportSturctureItems (R)

Footer AsReportStructureItems (R)

Body AsReportStructureItems (R)SubSectionStructure As

SectionStructure (R)Master As DocumentVariable

(R/W)IsGeneral As Boolean (R)IsTerminal As Boolean (R)

Sub Delete()

*BlockStructure

ReportStructureItems

Application As Application (R)Parent As Object (R)Count As Long (R)

Property Item(Index As Long)As ReportStructureItem

ReportStructureItem

Application As Application(R)

Parent As Object (R)Type As BoReportItemType

(R)

Sub ApplyStdStyle()Sub Delete()

*CellStructure

ValueType AsBoCellValueType (R)

Variable AsDocumentVariable (R)

Sub Clear()Pivot

Application As Object (R)Parent As Object (R)

Columns(Index As Long) AsDocumentVariable (R/W)

ColumnsCount As Long (R)Rows(Index As Long) AsDocumentVariable (R/W)RowsCount As Long (R)Body(Index As Long) AsDocumentVariable (R/W)BodyCount As Long (R)

Sub Apply()Sub Reset()

BoHtmlLayout

boHtmlOnePageboHtmlSectionBySectionboHtmlBoth

BusinessObjects Object Model - Reports

Legend

Collection

Object

Enum

BoCellValueType

boDocumentVariableboEmptyboOLEObject

BoReportItemType

boCellboTableboCrosstabboChart

*These objects inherit all ofReportStructureItem’s propertiesand methods.

8

Page 12: BusinessObjects SDK Object Model Diagrams

VBE

VBComponent

Property

CodePane

CodeModuleWindow

EventsCommandBar

CommandBarControl

VBProject

Reference

Legend

Object and Collection

Object Only

VBE 5.0 Object Model - Overview

9

Page 13: BusinessObjects SDK Object Model Diagrams

VBE

Application As Application (R)Parent As Object (R)

VBProjects As VBProjects (R)Windows As Windows (R)

CodePanes As CodePanes (R)CommandBars As CommandBars (R)ActiveCodePane As CodePane (R/W)

ActiveVBProject As VBProject (R)ActiveWindow As Window (R)MainWindow As Window (R)SelectedVBComponent As

VBComponent (R)Version As String (R)Events As Events (R)

VBPro jects

Application As Application (R)Parent As Object (R)Count As Long (R)

VBE As VBE (R)

Function Item (Index As Variant)As VBProject

Event ITEMADDED

Event ITEMREMOVED

VBProject

Application As Application (R)Parent As Object (R)

Collection As VBProjects (R)Description As String (R/W)

HelpContextID As String (R/W)HelpFile As String (R/W)

Mode As VbextMode (R/W)Name As String (R/W)

Protection As VbextProtection (R)References As References (R)

Saved As Boolean (R/W)VBComponents AsVBComponents (R)

VBE As VBE (R)

Windows

Application As Application (R)Parent As Object (R)Creator As Long (R)Count As Long (R)

Function Item ( Index As Variant)As Window

Window

Application As Application (R)Parent As Object (R)

Caption As String (R/W)Collection As Windows (R)

Height As Long (R/W)Left As Long (R/W)

LinkedWindowFrame As Window (R)Top As Long (R/W)

Type As VbextWindowType (R)VBE As VBE (R)

Visible As Boolean (R/W)Width As Long (R/W)

WindowState As VbextWindowState (R/W)

Sub Close ( [SaveChanges As Boolean], [FileName As String],[RouteDocument As Boolean])

Sub SetFocus ()

Events

Application As Application (R)Parent As Object (R)

CommandBarE vents (CommandBarControl As CommandBarControl) As CommandBarEvents (R)ReferencesEvent s(VBProject As VBProject) As ReferencesEvents (R)

References

Application As Application (R)Parent As Object (R)Count As Long (R)

VBE As VBE (R)

Function AddFromFile ( FileName As String) AsReference

Function AddFromGUID ( guid As String, majorAs Long, minor As Long) As Reference

Function Item ( Index As Variant) As ReferenceSub Remove (component As component)

Event ITEMADDED

Event ITEMREMOVED

Application As Application (R)Parent As Object (R)

BuiltIn As Boolean (R)Collection As References (R)

Description As String (R)FullPath As String (R)

GUID As String (R)IsBroken As Boolean (R)

Major As Long (R)Minor As Long (R)Name As String (R)

Type As VbextReferenceType (R)VBE As VBE (R)

Reference

VbextMode

vbext_vm_RunModevbext_vm_BreakModevbext_vm_DesignMode

VbextProtection

vbext_pp_lockedvbext_pp_none

VbextWindow Type

vbext_wt_CodeWindowvbext_wt_Designervbext_wt_Browservbext_wt_Watchvbext_wt_Localsvbext_wt_Immediatevbext_wt_ProjectWindowvbext_wt_PropertyWindowvbext_wt_Findvbext_wt_FindReplacevbext_wt_LinkedWindowvbext_wt_MainWindow

VbextWindowS tate

vbext_ws_Normalvbext_ws_Minvbext_ws_Max

VbextReference Type

vbext_rk_TypeLibvbext_rk_Project

VbextReference Type

vbext_rk_TypeLibvbext_rk_Project

VBE 5.0 Object Model - Core

Legend

Collection

Object

Enum

10

Page 14: BusinessObjects SDK Object Model Diagrams

BuiltInFace As Boolean (R/W)FaceId As Long (R/W)

ShortcutText As String (R/W)State As msoButtonState (R/W)Style As msoButtonStyle (R/W)

Sub CopyFace ()Sub PasteFace ()

Comma ndBars

Application As Application (R)Parent As Object (R)

ActionControl As CommandBarControl (R)ActiveMenuBar As CommandBar (R)

Count As Long (R)Creator As Long (R)

DisplayKeysInTooltips As Boolean (R/W)DisplayTooltips As Boolean (R/W)

Item (Index As Variant) As CommandBar (R)LargeButtons As Boolean (R/W)

MenuAnimationStyle AsmsoMenuAnimation (R/W)

Function Add ([Name As Variant], [PositionAs msoBarPosition], [MenuBar As Boolean],[Temporary As Boolean]) As CommandBar

Function FindControl ([Type AsmsoControlType], [Id As Variant], [Tag As

Variant], [Visible As Boolean], [Recursive AsBoolean]) As CommandBarControl

Sub ReleaseFocus ()

CommandBar

Application As Application (R)Parent As Object (R)

BuiltIn As Boolean (R)Context As String (R/W)

Controls As CommandBarControls (R)Creator As Long (R)

Enabled As Boolean (R/W)Height As Long (R/W)

Index As Long (R)Left As Long (R/W)

Name As String (R/W)NameLocal As String (R/W)

Position As msoBarPosition (R/W)Protection As msoBarProtection (R/W)

RowIndex As Long or msoBarRow (R/W)Top As Long (R/W)

Type As msoBarType (R)Visible As Boolean (R/W)

Width As Long (R/W)

Sub Delete()Sub Reset()

Sub Show Popup ([x As Variant], [y AsVariant])

CommandBarC ontrols

Application As Application (R)Parent As Object (R)Count As Long (R)

Creator As Long (R)Item (Index As Variant) As CommandBarControl (R)

Function Add ([Type As msoControlType], [Id AsLong], [Parameter As Long], [Before As Long],

[Temporary As Boolean]) As CommandBarControl

CommandBar Control

Application As Application (R)Parent As Object (R)

BeginGroup As Boolean (R/W)BuiltIn As Boolean (R)

Caption As String (R/W)Creator As Long (R)

DescriptionText As String (R/W)Enabled As Boolean (R/W)

Height As Long (R/W)HelpContextId As Long (R/W)

HelpFile As String (R/W)Id As Long (R)

Index As Long (R)Left As Long (R)

OLEUsage As msoControlOLEUsage (R/W)OnAction As String (R/W)Parameter As String (R/W)

Priority As Long (R/W)Tag As String (R/W)

TooltipText As String (R/W)Top As Long (R)

Type As msoControlType (R)Visible As Boolean (R/W)

Width As Long (R/W)

Sub Copy ([Bar As CommandBar], [Before As Variant])Sub Delete ([Temporary As Boolean])

Sub Execute()Sub Move([Bar As CommandBar], [Before As Variant])

Sub Reset()Sub SetFocus ()

*CommandB arButton

*CommandBa rComboBox

DropDownLines As Long (R/W)DropDownWidth As Long (R/W)

List (Index As Long) As String (R/W)ListCount As Long (R)

ListHeaderCount As Long (R/W)ListIndex As Long (R/W)

Style As msoComboStyle (R/W)Text As String (R/W)

TooltipText As String (R/W)

Sub AddItem (Text As String, [Index As Variant])Sub Clear()

Sub RemoveItem (Index As Long)

*Command BarPopup

CommandBar As CommandBar (R)Controls As CommandBarControls (R)

OLEMenuGroup As msoOLEMenuGroup (R/W)TooltipText As String (R/W)

MsoControlOLE Usage

msoControlOLEUsageNeithermsoControlOLEUsageServermsoControlOLEUsageClientmsoControlOLEUsageBoth

MsoControl Type

msoControlCustommsoControlButtonmsoControlEditmsoControlDropdownmsoControlComboBoxmsoControlButtonDropdownmsoControlSplitDropdownmsoControlGenericDropdownmsoControlGraphicCombomsoControlSplitButtonMRUPopupmsoControlSplitExpandingGridmsoControlGraphicDropdownmsoControlPopupmsoControlGraphicPopupmsoControlButtonPopupmsoControlGaugemsoControlLabelmsoControlExpandingGridmsoControlGridmsoControlOCXDropDownmsoControlSplitButtonPopup

MsoMenuAnim ation

msoMenuAnimationNonemsoMenuAnimationRandommsoMenuAnimationUnfoldmsoMenuAnimationSlide

MsoBarProtec tion

msoBarNoProtectionmsoBarNoCustomizemsoBarNoResizemsoBarNoMovemsoBarNoChangeVisiblemsoBarNoChangeDockmsoBarNoVerticalDockmsoBarNoHorizontalDock

MsoBarPosi tion

msoBarLeftmsoBarTopmsoBarRightmsoBarBottommsoBarFloatingmsoBarPopupmsoBarMenu

MsoBar Type

msoBarTypeNormalmsoBarTypeMenuBarmsoBarTypePopup

MsoB arRow

msoBarRowFirstmsoBarRowLast

MsoButton Style

msoButtonAutomaticmsoButtonIconmsoButtonCaptionmsoButtonIconandCaption

MsoButtonS tate

msoButtonUpmsoButtonDownmsoButtonMixed

MsoCombo Style

msoComboLabelmsoComboNormal

MsoOLEMe nuGroup

msoOleMenuGroupNonemsoOleMenuGroupFilemsoOleMenuGroupEditmsoOleMenuGroupContainermsoOleMenuGroupObjectmsoOleMenuGroupWindowmsoOleMenuGroupHelp

VBE 5.0 Object Model - Command Bars

Legend

Collection

Object

Enum

11

*These objects inherit all ofCommandBarControl's properties andmethods

Page 15: BusinessObjects SDK Object Model Diagrams

CodePanes

Application As Application (R)Parent As Object (R)Count As Long (R)

VBE As VBE (R)

Function Item (Index As Variant)As CodePane

CodePane

Application As Application (R)Parent As Object (R)

CodeModule As CodeModule (R)CodePaneView As VbextCodePaneView (R)

Collection As CodePanes (R)CountOfVisibleLines As Long (R)

TopLine As Long (R/W)VBE As VBE (R)

Window As Window (R)

Sub GetSelection (Startline As Long , startcol As Long,endline As Long, endcol As Long)

Sub SetSelection (Startline As Long , startcol As Long,endline As Long, endcol As Long)

Sub Show ()

VBComp onents

Application As Application (R)Parent As Object (R)Count As Long (R)

VBE As VBE (R)

Function Add (Component As VbextComponent) As VBComponentFunction Import (FileName As String) As VBComponent

Function Item (Index As Variant) As VBComponentSub Remove (component As component)

VBCom ponent

Application As Application (R)Parent As Object (R)

CodeModule As CodeModule (R)Collection As VBComponents (R)

Designer As Designer (R)DesignerWindow As Window (R)

HasOpenDesigner As Boolean (R)Name As String (R/W)

Properties As Properties (R)Saved As Boolean (R/W)

Type As VbextVBComponentType (R)VBE As VBE (R)

Sub Activate ()Sub Export ( FileName As String)

Properties

Application As Application (R)Parent As Object (R)Count As Long (R)

VBE As VBE (R)

Function Item (Index As Variant) As Property

Prop erty

Application As Application (R)Parent As Object (R)

Collection As Properties (R)IndexedValue (Index As Long) As Variant

Name As String (R/W)NumIndices As Long (R)Object As Object (R/W)Value As Variant (R/W)

VBE As VBE (R)

CodeMo dule

Application As Application (R)Parent As Object (R)

CodePane As CodePane (R)CountOfDeclarationLines As Long (R)

CountOfLines As Long (R)VBE As VBE (R)

Sub AddFromFile (FileName As String)Sub AddFromString ( String As String)

Function CreateEven tProc (eventname As String, objectname As Variant) As LongSub DeleteLines (startline As Long, [count As Long])

Function Find (target As String, startline As Long, startcol As Long, endline As Long, endcolAs Long, [wholeword As Boolean], [matchcase As Boolean], [patternsearch As Boolean]) As

BooleanSub InsertLines (line As Long, code As String)

Function Lines (startline As Long, count As Long) As StringFunction ProcBody Line (procname As String, prockind As VbextProcKind) As Long

Function ProcCount Lines (procname As String, prockind As VbextProcKind) As LongFunction ProcOfLine (line As Long, prockind As VbextProcKind) As String

Function ProcStartLine (procname As String, , prockind As VbextProcKind) As LongSub ReplaceLine (line As Long, code As String)

VbextCodePa neView

vbext_cv_ProcedureViewvbext_cv_FullModuleView

VbextComp onent

vbext_ct_ClassModulevbext_ct_MSFormvbext_ct_StdModule

VbextVBCompon entType

vbext_ct_ClassModulevbext_ct_MSFormvbext_ct_StdModulevbext_ct_Document

VbextPro cKind

vbext_pk_Getvbext_pk_Letvbext_pk_Setvbext_pk_Proc

VBE 5.0 Object Model - Code Panes and VB Components

Legend

Collection

Object

Enum12

Page 16: BusinessObjects SDK Object Model Diagrams

DpVBAInterface

DpVBA Cube

DpVBAColumn

Legend

Object and Collection

Object Only

DpVBAInterface Object Model - Overview

13

Page 17: BusinessObjects SDK Object Model Diagrams

Parent As Object (R)CancelOnExit As Boolean (R/W)

DpVBACubes As DpVBACubes (R)IsEdit As Boolean (R)

Property UserString(Index AsLong) As String (R/W)

UserStringCount As Long (R)ShowSelectionDialogOnEdit As

Boolean (R/W)

CheckDataIntegrity(Level AsBoCheckLevel)

DPVBAInterface

DPVBACubes

Parent As Object (R)Count As Long (R)

Property Item(Index As Long) AsDpVBACube (R)

DPVBACube

Parent As Object (R)DpVBAColumns As DpVBAColumns (R)

DPVBAColumns

Parent As Object (R)Count As Long (R)

Property Item(Index As Long) As DPVBAColumn (R)NbLines As Long (R/W)

Function Add(sColName As String) As Long*Function AddLine(NewValue As Variant) As Long

Sub SetNbColumns(nNbColumns As Long)

DPVBAColumn

Parent As Object (R)Aggregation As BoObjectAggregation (R/W)Qualification As BoObjectQualification (R/W)

Type As BoObjectType (R/W)Name As String (R/W)

Index As Long(R)Property Item(Index As Long) As Variant (R/W)

MaxWidth As Long (R/W)

†Function Add(Val As Variant) As LongFunction Delete() As Boolean

DpVBAInterface Automation Object Model - Core

Legend

Collection

Object

Enum

BoCheckLevel

boCheckAllboCheckAutoTypingboCheckChangeTypeboCheckColumnsNameboCheckNumberOfCubeboNoCheck

BoObjectQualification

boDetailboDimensionboMeasure

BoObjectType

boCharacterObjectboDateObjectboNullObjectboNumericObject

BoObjectAggregation

boAggregateByAvgObjectboAggregateByCountObjectboAggregateByMaxObjectboAggregateByMinObjectboAggregateByNullObjectboAggregateBySumObject

*The parameter Newvalue must be declared as an array. This array may be: - A one-dimensional array with the same size as the number of columns in the data cube. - A two-dimensional array. The first dimension represents the rows and the second dimension represents the columns. The second dimension must be equal to the number of columns in the data cube.

†If several values are added, Val must be declared as an array.

14

Page 18: BusinessObjects SDK Object Model Diagrams

Application

Universe

Connection

CmdBar

Variable

Class

Object

PredefinedCond ition

Window

ObjectStra tegyTable

Join

JoinStrategy

TableStra tegy

CandidateJoin

DBTable

CandidateClass

DBColumn

Column

Context

CustomHierarchy

Qualifier

Owner

LinkedUniverse

SQLOption

ControlOption

UniverseD omain

StoredUniverse

ListofValues

Designer Object Model - Overview

User

NetworkL ayer

DatabaseEngine

CandidateObject

CandidatePredefinedCon dition

DefaultHierarchy

CheckedItem

Legend

Object and Collection

Object Only

15

Page 19: BusinessObjects SDK Object Model Diagrams

DsDirectoryID

dsDesignerDirectorydsDocumentDirectorydsTemplateDirectorydsUniverseDirectorydsScriptsDirectory

DsVariableType

dsDateVariabledsNumericVariabledsStringVariable

Application

Application As Application (R)Parent As Object (R)

ActiveUniverse As Universe (R)Universes As Universes (R)

UniverseDomains AsUniverseDomains (R)

Connections As Connections (R)Interactive As Boolean (R/W)

Name As String (R)CmdBars As CmdBars (R)

NetworkLayers As NetworkLayers(R)

Variables As Variables (R)Version As String(R)

Visible As Boolean (R/W)Window As Window (R)

FunctionGetInstallDirectory(DirectoryID As

DsDirectoryID) As StringSub LoginAs([User As String],

[Pass As String], [Offline AsBoolean], [RepositoryName As

String])Sub Quit()

CmdBars

Application As Application (R)Parent As Object (R)Count As Long (R)

Property Item(Index As Variant) AsCmdBar (R)

Variables

Application As Application (R)Parent As Object (R)Count As Long (R)

Property Item(Index As Variant) AsVariable (R)

Function Add(Name As String) AsVariable

Universe

Application As Application (R)Parent As Object (R)

LongName As String (R/W)Description As String (R/W)Connection As String (R/W)

Author As String (R)Modifier As String (R)

CreationDate As String (R)ModificationDate As String (R)RevisionNumber As Long (R)

Comments As String (R/W)FullName As String (R)

Name As String (R)Path As String (R)

Saved As Boolean (R)Windows As Windows (R)

Tables As Tables (R)Classes As Classes (R)

Joins As Joins (R)Contexts As Contexts (R)

DefaultHierarchies As DefaultHierarchies (R)CustomHierarchies As CustomHierarchies (R)

ControlOption As ControlOption (R)SQLOption As SQLOption (R)

LinkedUniverses As LinkedUniverses (R)

OwnerSupported As Boolean (R)QualifierSupported As Boolean (R)

DBtables As DBTables (R)Qualifiers As Qualifiers (R)

Owners As Owners (R)

ObjectStrategies As ObjectStrategies (R)JoinStrategies As JoinStrategies (R)

TableStrategies As TableStrategies (R)

CandidateJoins As CandidateJoins (R)CandidateClasses As CandidateClasses (R)

CurrentQualifier As String (R/W)CurrentOwner As String (R/W)

CurrentJoinStrategy As String (R/W)CurrentObjectStrategy As String (R/W)CurrentTableStrategy As String (R/W)

UseCustomHierarchies As Boolean(R/W)

Sub Activate()Sub Close()

Sub PrintOut([PrinterName As Variant])Sub PrintDialog()

Sub Save()Sub SaveAs([Name As Variant])

Sub ArrangeTables()Sub RefreshStructure()

Function CheckIntegrity(Filter AsDsCheckFilter, ParseLevel As

DsCheckParseLevel) As CheckedItems

CmdBar

Application As Application(R)

Parent As Object (R)Visible As Boolean (R/W)

Name As String (R/W)

Variable

Application As Application(R)

Parent As Object (R)Name As String (R)

InterpretAs AsDsVariableType (R/W)Value As String (R/W)

MultiValued As Boolean(R)

Sub Delete()

Universes

Application As Application (R)Parent As Object (R)Count As Long (R)

Property Item(Index As Variant) As Universe (R)

Function Add() As UniverseFunction Open([UniverseName As String]) As

UniverseSub Import(UniverseDomainName As String,

UniverseName As String, [Lock])Sub Export(DomainName As String, GroupName

As String, UniverseName As String, [Lock])Sub ExportEx(DomainName As String,

GroupName As Array of String, UniverseName AsString, [Lock As Variant])

Designer Object Model - Core

DsWindowState

dsMaximizeddsMinimizeddsNormal

Legend

Collection

Object

Enum

Window

Application As Application (R)Parent As Object (R)

Caption As String (R/W)Height, Width,Top, Left As Long (R/W)

State As DsWindowState (R/W)

Sub Activate()Sub Close()

DsCheckFilter

dsCheckCardinalitydsCheckConditiondsCheckContextdsCheckJoindsCheckLoopdsCheckObjectdsCheckStructure

DsCheckParseLevel

DsCheckQuickParsingDsCheckThoroughParsing

Windows

Application As Application (R)Parent As Object (R)Count As Long (R)

Property Item(Index As Variant) AsWindow (R)

16

Page 20: BusinessObjects SDK Object Model Diagrams

Designer Object Model - Connections and NetworkLayers

Connections

Application As Application (R)Parent As Object (R)Count As Long (R)

Property Item(Index As Variant) As Connection (R)

Function Add(Name As String, Type AsDsConnectionType, NetworkLayer As String,

DatabaseEngine As String, [DatabaseSource AsString], [UserName As String], [Password As String],

[Server As String]) As ConnectionFunction AddDialog() As Connection

Connection

Application As Application (R)Parent As Object (R)Name As String (R)

Type As DsConnectionType (R)UseBOUserPass As Boolean (R/W)

NetworkLayer As String (R)DatabaseEngine As String (R/W)DatabaseSource As String (R/W)

UserName As String (R/W)Password As String (R/W)

Server As String (R/W)

ActiveState As DsConnectionState (R/W)ActiveTime As Long (R/W)

IsAsyncMode As Boolean (R/W)PerformCostEstimate As Boolean (R/W)

ArrayFetchSize As Long (R/W)

Sub Test()Sub Delete()

NetworkLayers

Application As Application (R)Parent As Object (R)Count As Long (R)

Property Item(Index As Variant)As NetworkLayer (R)

NetworkLayer

Application As Application (R)Parent As Object (R)Name As String (R)

DatabaseEngines AsDatabaseEngines (R)

DatabaseEngines

Application As Application (R)Parent As Object (R)Count As Long (R)

Property Item(Index As Variant)As DatabaseEngine (R)

DatabaseEngine

Application As Application (R)Parent As Object (R)Name As String (R)

Legend

Collection

Object

Enum

DsConnectionType

dsPersonaldsSecureddsShared

DsConnectionState

dsDisconnectAfterEachTransactiondsKeepActiveForxxdsKeepActiveWholeSession

17

Page 21: BusinessObjects SDK Object Model Diagrams

UniverseDomains

Application As Application (R)Parent As Object (R)Count As Long (R)

Property Item(Index As Variant) AsUniverseDomain (R)

UniverseDomain

Application As Application (R)Parent As Object (R)Name As String (R)

StoredUniverses AsStoredUniverses (R)Users As Users (R)

StoredUniverses

Application As Application (R)Parent As Object (R)Count As Long (R)

Property Item(Index As Variant)As StoredUniverse (R)

StoredUniverse

Application As Application (R)Parent As Object (R)Name As String (R)

LockBy As String (R)

Users

Application As Application (R)Parent As Object (R)Count As Long (R)

Property Item(Index As Variant) As User (R)

User

Application As Application (R)Parent As Object (R)Name As String (R)

Designer Object Model - UniverseDomains and Users

Legend

Collection

Object

Enum

18

Page 22: BusinessObjects SDK Object Model Diagrams

ObjectStrategies

Appl ication As Application (R)Parent As Object (R)Count As Long (R)

Property Item (Index As Variant) As ObjectStrategy (R)

ObjectStrategy

Appl ication As Application (R)Parent As Object (R)Name As String (R)Help As String (R)

CandidateClasses

Appl ication As Application (R)Parent As Object (R)Count As Long (R)

Property Item (Index As Variant) AsCandidateClass (R)

Sub Refresh ()

CandidateClass

Appl ication As Application (R)Parent As Object (R)Name As String (R)

CandidateObjects As CandidateObjects (R)CandidateClasses As CandidateClasses (R)

CandidatePredefinedConditions AsCandidatePredefinedConditions (R)

Function Insert () As Class

CandidateObjects

Appl ication As Application (R)Parent As Object (R)Count As Long (R)

Property Item (Index As Variant) AsCandidateObject (R)

CandidateObject

Appl ication As Application (R)Parent As Object (R)Name As String (R)

Function Insert (Class As Class) As Object

CandidatePredefinedCond itions

Appl ication As Application (R)Parent As Object (R)Count As Long (R)

Property Item (Index As Variant) AsCandidatePredefinedCondition (R)

CandidatePredefinedCon dition

Appl ication As Application (R)Parent As Object (R)Name As String (R)

Function Insert (Class As Class) AsPredefinedCondition

Designer Object Model - ObjectStrat egies and CandidateClasses

Legend

Collection

Object

Enum

19

Page 23: BusinessObjects SDK Object Model Diagrams

JoinStrategies

Application As Application (R)Parent As Object (R)Count As Long (R)

Property Item(Index As Variant) As JoinStrategy (R)

JoinStrategy

Application As Application (R)Parent As Object (R)Name As String (R)Help As String (R)

CandidateJoins

Application As Application (R)Parent As Object (R)Count As Long (R)

Property Item(Index As Variant) As CandidateJoin (R)

Sub Refresh()

CandidateJoin

Application As Application (R)Parent As Object (R)

FirstTable As String(R)SecondTable As String (R)FirstColumn As String (R)

SecondColumn As String (R)Expression As String (R)

Cardinality As DsCardinality (R)OuterJoin As DsOuterJoin (R)

Function Insert() As Join

DsCardinality

dsManytoManyCardinalitydsManytoOneCardinalitydsOnetoManyCardinalitydsOnetoOneCardinalitydsUnknownCardinality

DsOuterJoin

dsNoOuterdsOuterLeftdsOuterRight

Designer Object Model - JoinStrategies and CandidateJoins

Legend

Collection

Object

Enum

20

Page 24: BusinessObjects SDK Object Model Diagrams

Designer Object Model - TableStrategies and DB Tables

LegendCollection

Object

Enum

TableStrategies

Application As Application (R)Parent As Object (R)Count As Long (R)

Property Item(Index As Variant) As TableStrategy (R)

TableStrategy

Application As Application (R)Parent As Object (R)Name As String (R)Help As String (R)

DBTables

Application As Application (R)Parent As Object (R)Count As Long (R)

Property Item(Index As Variant) As DBTable (R)

Sub Refresh()

DBTable

Application As Application (R)Parent As Object (R)Name As String(R)

DBColumns As DBColumns (R)

Function Insert() As Table

DBColumns

Application As Application (R)Parent As Object (R)Count As Long (R)

Property Item (Index As Variant) As DBColumn (R)

Sub Refresh()

DBColumn

Application As Application (R)Parent As Object (R)Name As String (R)

Type As DsColumnType (R)Key As DsColumnKey (R)

21

Page 25: BusinessObjects SDK Object Model Diagrams

PredefinedConditions

Application As Application (R)Count As Long (R)

Property Item(Index As Variant) AsPredefinedCondition (R)

Parent As Object (R)

Function Add(Name As String,[ClassName As String]) As

PredefinedCondition

PredefinedCondition

Application As Application (R)Description As String (R/W)

Name As String (R/W)Parent As Object (R)

RootClass As Class (R)Show As Boolean (R/W)

Tables As Tables (R)Where As String (R/W)

Sub Delete()Sub Parse()

Objects

Object

ActiveMonth As BooleanActiveQuarter As Boolean

ActiveYear As BooleanAggregateFunction As DsObjectAggregate

(R/W)AllowUserToEditLov As Boolean (R/W)

Application As Application (R/W)AssociatedDimension As Object (R/W)

AutomaticLovRefreshBeforeUse As Boolean(R/W)

CanBeUsedCondition As Boolean (R/W)CanBeUsedResult As Boolean (R/W)CanBeUsedSort As Boolean (R/W)DatabaseFormat As String (R/W)

Description As String (R/W)ExportLovWithUniverse As Boolean (R/W)

HasListofValues As Boolean (R/W)ListofValues As ListofValues (R)

MonthName As String (R)Name As String (R/W)Objects As Objects (R)Parent As Object (R)

Qualification As DsObjectQualification (R/W)QuarterName As String (R)

RootClass As Class (R)SecurityAccessLevel As

DsObjectSecurityAccess (R/W)Select As String (R/W)

Show As Boolean (R/W)Tables As Tables (R)

Type As DsObjectType (R/W)Where As String (R/W)

YearName As String (R/W)

Sub Parse()Sub Delete()

Classes

Application As Application (R)Count As Long (R)

FindClass(Name As String) As Class (R)Item(Index As Variant) As Class (R)

Parent As Object (R)

Function Add(Name As String) As Class

Class

Application As Application (R)Classes As Classes (R)

Description As String (R/W)Name As String (R/W)Objects As Objects (R)Parent As Object (R)

PredefinedConditions AsPredefinedConditions (R)RootClass As Class (R)

Show As Boolean (R)

Sub Delete()

ListofValues

Application As Application (R)Name As String (R/W)Parent As Object (R)

Sub Edit()Sub Purge()

Sub Refresh()Values As Variant (R)*

Application As Application (R)Count As Long (R)

Property Item(Index As Variant) AsObject (R)

Parent As Object (R)

Function Add(Name As String,[ClassName As String]) As Object

DsObjectAggregate

dsAggregateBySumObjectdsAggregateByMaxObjectdsAggregateByMinObjectdsAggregateByAvgObjectdsAggregateByCountObjectdsAggregateByNullObject

DsObjectType

dsNullObjectdsNumericObjectdsCharacterObjectdsDateObjectdsBlobObject

DsObjectQualification

dsAxisObjectdsInformationObjectdsMeasureObject

DsObjectSecurityAccess

dsPublicAccessdsControlledAccessdsRestrictedAccessdsConfidentialAccessdsPrivateAccess

Designer Object Model - Classes and Objects

LegendCollection

Object

Enum

*Returns an array containing the list of values.22

Page 26: BusinessObjects SDK Object Model Diagrams

Application As Application (R)Parent As Object (R)Name As String (R/W)IsAlias As Boolean (R)

OriginalTable As Table (R)Weight As Long (R/W)

Columns As Columns (R)IncompatibleObjects As Objects

IncompatiblePredefConditions AsPredefinedConditions

Sub Delete()Function CreateAlias(Name As String) As TableFunction CreateClass(Name As String) As Class

Tables

Application As Application (R)Parent As Object (R)Count As Long (R)

Property Item(Index As Variant) As Table (R)

Function Add(Name As String) As TableSub DetectIncompatibility()

Table

Columns

Column

Application As Application (R)Parent As Object (R)Name As String (R)

Type As DsColumnType (R/W)Key As DsColumnKey (R/W)

Sub Delete()

Joins

Application As Application (R)Parent As Object (R)Count As Long (R)

Property Item(Index As Variant) As Join (R)

Function Add(Expression As String) As JoinSub Detect()

Join

Application As Application (R)Parent As Object (R)

FirstTable As Table (R)SecondTable As Table (R)

FirstColumns As Columns (R)SecondColumns As Columns (R)

Expression As String (R/W)Shortcut As Boolean (R/W)

Cardinality As DsCardinality (R/W)OuterJoin As DsOuterJoin (R/W)

Sub SetCardinality()Function Parse() As Boolean

Sub Delete()

Contexts

Application As Application (R)Parent As Object (R)Count As Long (R)

Property Item(Index As Variant) As Context (R)

Function Add(Name As String) As ContextSub Detect()

Context

Application As Application (R)Parent As Object (R)Name As String(R/W)

Description As String(R/W)Joins As Joins (R)

Sub Delete()

Application As Application (R)Parent As Object (R)Count As Long (R)

Property Item(Index As Variant) As Column (R)

Function Add(Name As String) As Column

DsCardinality

dsManytoManyCardinalitydsManytoOneCardinalitydsOnetoManyCardinalitydsOnetoOneCardinalitydsUnknownCardinality

DsColumnKey

dsUnknownKeydsAllKeydsNoKeydsPrimaryKeydsSecondaryKeydsExternKey

DsOuterJoin

dsNoOuterdsOuterLeftdsOuterRight

DsColumnType

dsNullColumndsNumericColumndsCharacterColumndsDateColumndsTextColumndsUnknownColumn

Designer Object Model - Tables, Joins and Contexts

Legend

Collection

Object

Enum

23

Page 27: BusinessObjects SDK Object Model Diagrams

CustomHiera rchies

Appl ication As Application (R)Parent As Object (R)Count As Long (R)

Property Item (Index As Variant) AsCustomHierarchy (R)

Function Add (Name As String) As CustomHierarchy

CustomHi erarchy

Appl ication As Application (R)Parent As Object (R)Name As String (R/W)

Dimensions As Object s (R/W)

Sub Delete ()

DefaultHierarchies

Appl ication As Application (R)Parent As Object (R)Count As Long (R)

Property Item (Index As Variant) As DefaultHierarchy (R)

DefaultHier archy

Appl ication As Application (R)Parent As Object (R)Name As String (R/W)

Dimensions As Object s (R/W)

Designer Object ModelCustomHierarchies, DefaultHierarchies, Qualifiers, and Owners

Qualifiers

Appl ication As Application (R)Parent As Object (R)Count As Long (R)

Property Item (Index As Variant) As Qualifier (R)

Sub Refresh ()

Qualifier

Appl ication As Application (R)Parent As Object (R)Name As String (R)

Owners

Appl ication As Application (R)Parent As Object (R)Count As Long (R)

Property Item (Index As Variant) As Owner (R)

Sub Refresh ()

Owner

Appl ication As Application (R)Parent As Object (R)Name As String (R)

Legend

Collection

Object

Enum

24

Page 28: BusinessObjects SDK Object Model Diagrams

SQLOption

Application As Application (R)Parent As Object (R)

SubQueries As Boolean (R/W)Operators As Boolean (R/W)

ComplexOperators As Boolean (R/W)MultipleSQLForContext As Boolean (R/W)MultipleSQLForMeasure As Boolean (R/W)SelectMultipleContexts As Boolean (R/W)

PreventCartesianProducts As Boolean (R/W)

ControlOption

Application As Application (R)Parent As Object (R)

LimitSizeofResultSet As Boolean (R/W)LimitSizeofResultSetValue As Long (R/W)

LimitExecutionTime As Boolean (R/W)LimitExecutionTimeValue As Long (R/W)

WarnIfCostEstimateExceeded As Boolean (R/W)CostEstimateExceededValue As Long (R/W)

LimitSizeofLongTextObject As Boolean (R/W)LimitSizeofLongTextObjectValue As Long (R/W)

LinkedUniverses

Application As Application (R)Parent As Object (R)Count As Long (R)

Property Item(Index As Variant) As LinkedUniverse (R)

Function Add(Name As String) As LinkedUniverse

LinkedUniverse

Application As Application (R)Parent As Object (R)Name As String (R)

FullName As String (R)LongName As String (R)Description As String(R)

Sub Delete()Sub Merge()

Designer Object ModelLinkedUniverses, SQLOption and ControlOption

Legend

Collection

Object

Enum

CheckedItems

Application As Application (R)Parent As Object (R)Count As Long (R)

Filter As DsCheckFilterProperty Item(Index As Long) As CheckedItem (R)

ParseLevel As DsCheckParseLevel (R)

CheckedItem

Application As Application (R)AssociatedObject As Object (R)

CheckError As DsCheckError (R)CheckErrorDescription As String (R)

Parent As Object (R)SubItems As CheckedItems (R)Type As DsCheckItemType (R)

Filter As Long (R)

DsCheckParseLevel

DsCheckQuickParsingDsCheckThoroughParsing

DsCheckFilter

dsCheckCardinalitydsCheckConditiondsCheckContextdsCheckJoindsCheckLoopdsCheckObjectdsCheckStructure

DsCheckError

dsCheckErrorColumnHasBeenAddeddsCheckErrorColumnHasChangeddsCheckErrorColumnNotFounddsCheckErrorConnectiondsCheckErrorContextHasLoopdsCheckErrorContextInvolvedInLoopdsCheckErrorContextIsolatedJoindsCheckErrorJoinBadCardinalitydsCheckErrorJoinMissingCardinalitydsCheckErrorJoinParseFaileddsCheckErrorJoinUnknownCardinalitydsCheckErrorLoopInContextdsCheckErrorLoopNotSolveButContextdsCheckErrorLoopNotSolveByContextdsCheckErrorLoopSolveByContextdsCheckErrorLoopSolveByContextWithLoopdsCheckErrorObjectParseFaileddsCheckErrorPredefinedConditionParseFaileddsCheckErrorTableHasChangeddsCheckErrorTableIsNotInDataStructuredsCheckErrorTableNotLinked

DsCheckItemType

dsCheckedColumndsCheckedContextdsCheckedJoindsCheckedLoopdsCheckedNulldsCheckedObjectdsCheckedPredefinedConditiondsCheckedTable

25

Page 29: BusinessObjects SDK Object Model Diagrams

RptViewer

RptViewerDomain

RptReport

RptDocument

RptSection

RptViewerCate gory

Legend

Object and Collection

Object Only

Report Viewer Component Object Model - Overview

RptDocumentView

26

Page 30: BusinessObjects SDK Object Model Diagrams

Name As String (R)Number As Integer (R)Parent As Object (R)

Sections AsRptSections (R)

Sub Activate()Sub PrintOut(bSilent As

Boolean)

Type As RptRepoType (R)Name As String (R)

Parent As Object (R)

Sub Close()Function Reports() As

RptReportsSub Open()

Sub PrintOut(bSilent AsBoolean)

Sub Refresh()

RptViewer

BrowserComplete As Boolean (R/W)BrowserVisible As Boolean (R/W)

Parent As Object (R)ServerURL As String (R/W)

ToolBarVisible As Boolean (R/W)

Sub Connect([UserName],[UserPassword])Function Documents(repoType As RptRepoType,

sDomain As String, sFilter As String) As RptDocumentsFunction DocumentView() As RptDocumentView

Function Domains(RepoType As RptRepoType) AsRptDomains

Sub RefreshBrowser()Sub Server(major As Integer, minor As Integer,

maintenance As Integer)Sub Version(major As Integer, minor As Integer,

maintenance As Integer)

Function Categories(RepoType As RptRepoType) AsRptCategories

Sub Disconnect()

RptDocuments

Count As Long (R)Parent As Object (R)

Function Item(Index AsVariant) As RptDocument

RptDocument

RptReports

Count As Long (R)Parent As Object (R)

Function Item(Index AsVariant) As RptReport

RptReport

RptDocumentView

Parent As Object (R)Zoom As Single (R/W)

Sub Begin()Sub DownloadReport()

Sub End()Sub Next()

Sub Previous()Sub

SynchronizeTreeView()Sub ZoomIn()

Sub ZoomOut()

FunctionActiveDocument() As

RptDocumentActiveReport() As

RptReportActiveSection() As

RptSection

RptDomains

Count As Long (R)Parent As Object (R)

Function Item(Index AsVariant) As RptDomain

(R)

RptDomain

Name As String (R)Parent As Object (R)

RptSections

Count As Long (R)Parent As Object (R)

Function Item(Index AsVariant) As RptSection

RptSection

Name As String (R)Parent As Object

(R)

Sub Activate()Level As long (R)

RptCategories

Count As Long (R)Parent As Object (R)

Function Item(Index AsVariant) As RptCategory

RptCategory

Name As String (R)Parent As Object (R)

RptViewer Object Model - Core

Legend

Collection

Object

Enum

RptRepoType

rptRepoTypeCorporaterptRepoTypeInboxrptRepoTypePersonal

27

Page 31: BusinessObjects SDK Object Model Diagrams