List of all ScriptForge methods and properties /text/sbasic/shared/03/sf_toc.xhp ScriptForge; list of methods ScriptForge; list of properties

List of all ScriptForge methods and properties

This help page shows all methods and properties available in the ScriptForge library by service with links to the corresponding documentation. The Basic source code for all ScriptForge services is available via Application Macros and Dialogs and is distributed in multiple libraries: ScriptForge, SFDatabases, SFDialogs, SFDocuments, SFUnitTests and SFWidgets. The Python portion of the source code is available in the program\scriptforge.py file under the %PRODUCTNAME installation directory.

ScriptForge.Array service

SFDocuments.Base service

This service also supports the methods and properties defined in the Document service, which includes methods that are generic to all document types.

ScriptForge.Basic service

List of Properties in the Basic Service IDABORT
IDCANCEL
IDIGNORE
IDNO
IDOK
IDRETRY
IDYES
MB_ABORTRETRYIGNORE
 MB_DEFBUTTON1
MB_DEFBUTTON2
MB_DEFBUTTON3
MB_ICONEXCLAMATION
MB_ICONINFORMATION
MB_ICONQUESTION
MB_ICONSTOP
MB_OK
 MB_OKCANCEL
MB_RETRYCANCEL
MB_YESNO
MB_YESNOCANCEL
StarDesktop
ThisComponent
ThisDatabaseDocument

SFDocuments.Calc service

List of Properties in the Calc Service CurrentSelection
FirstCell
FirstColumn
FirstRow
Height
LastCell LastColumn
LastRow
Range
Region
Sheet
SheetName Sheets
Width
XCellRange
XSheetCellCursor
XSpreadsheet

SFDocuments.Chart service

List of Properties in the Chart Service ChartType
Deep
Dim3D
Exploded
Filled Legend
Percent
Stacked
Title
XTitle YTitle
XChartObj
XDiagram
XShape
XTableChart

SFDatabases.Database service

List of Properties in the Database Service Queries
Tables XConnection

 XMetaData

SFDatabases.Dataset service

List of Properties in the Dataset Service BOF
DefaultValues
EOF
Fields
Filter
 Orderby
ParentDatabase
RowCount
RowNumber
Source
 SourceType
UpdatableFields
Values
XRowSet

SFDatabases.Datasheet service

List of Properties in the Datasheet Service ColumnHeaders
CurrentColumn
CurrentRow
DatabaseFileName
Filter LastRow
OrderBy
ParentDatabase
Source

 SourceType
XComponent
XControlModel
XTabControllerModel

SFDialogs.Dialog service

List of Properties in the Dialog Service CANCELBUTTON
Caption
Height
Modal
Name
OKBUTTON
OnFocusGained
OnFocusLost OnKeyPressed
OnKeyReleased
OnMouseDragged
OnMouseEntered
OnMouseExited
OnMouseMoved
OnMousePressed
OnMouseReleased Page
Visible
Width
XChartObj
XDiagram
XDialogModel
XDialogView
XTableChart

SFDialogs.DialogControl service

List of Properties in the DialogControl Service Cancel
Caption
ControlType
CurrentNode
Default
Enabled
Format
ListCount
ListIndex Locked
MultiSelect
Name
Page
Parent
Picture
RootNode
RowSource

 Text
TipText
TripleState
Value
Visible
XControlModel
XControlView
XTreeDataModel

ScriptForge.Dictionary service

List of Properties in the Dictionary Service Count
 Items
 Keys

SFDocuments.Document service

List of Properties in the Document Service CustomProperties
Description
DocumentProperties
DocumentType
ExportFilters
FileSystem
ImportFilters
 IsBase
IsCalc
IsDraw
IsFormDocument
IsImpress
IsMath
IsWriter
 Keywords
Readonly
StyleFamilies
Subject
Title
XComponent
XDocumentSettings

ScriptForge.Exception service

List of Properties in the Exception Service Description
 Number
 Source

ScriptForge.FileSystem service

List of Properties in the FileSystem Service ConfigFolder
ExtensionsFolder
FileNaming
HomeFolder InstallFolder
Subject
TemplatesFolder
TemporaryFolder Title
UserTemplatesFolder
XComponent

SFDocuments.Form service

List of Properties in the Form Service AllowDeletes
AllowInserts
AllowUpdates
BaseForm
Bookmark
CurrentRecord
Filter
LinkChildFields
LinkParentFields
Name OnApproveCursorMove
OnApproveParameter
OnApproveReset
OnApproveRowChange
OnApproveSubmit
OnConfirmDelete
OnCursorMoved
OnErrorOccurred
OnLoaded
OnReloaded OnReloading
OnResetted
OnRowChanged
OnUnloaded
OnUnloading
OrderBy
Parent
RecordSource
XForm

SFDocuments.FormControl service

List of Properties in the FormControl Service Action
Caption
ControlSource
ControlType
Default
DefaultValue
Enabled
Format
ListCount
ListIndex
ListSource
ListSourceType
Locked
MultiSelect
Name
OnActionPerformed OnAdjustmentValueChanged
OnApproveAction
OnApproveReset
OnApproveUpdate
OnChanged
OnErrorOccurred
OnFocusGained
OnFocusLost
OnItemStateChanged
OnKeyPressed
OnKeyReleased
OnMouseDragged
OnMouseEntered
OnMouseExited
OnMouseMoved

 OnMousePressed
OnMouseReleased
OnResetted
OnTextChanged
OnUpdated
Parent
Picture
Required
Text
TipText
TripleState
Value
Visible
XControlModel
XControlView

SFDocuments.FormDocument service

ScriptForge.L10N service

List of Properties in the L10N Service Folder
 Language
 Locale

SFWidgets.Menu service

List of Properties in the Menu Service ShortcutCharacter
 SubmenuCharacter

ScriptForge.Platform service

List of Properties in the Platform Service Architecture
ComputerName
CPUCount
CurrentUser
Extensions
FilterNames
Fonts FormatLocale
Locale
Machine
OfficeLocale
OfficeVersion
OSName
OSPlatform OSRelease
OSVersion
Printers
Processor
PythonVersion
SystemLocale
UserData

SFWidgets.PopupMenu service

List of Properties in the PopupMenu Service ShortcutCharacter
 SubmenuCharacter

ScriptForge.Region service

List of Properties in the Region Service Country
Currency
DatePatterns
DateSeparator
DayAbbrevNames DayNames
DayNarrowNames
DecimalPoint
Language
ListSeparator MonthAbbrevNames
MonthNames
MonthNarrowNames
ThousandSeparator
TimeSeparator

ScriptForge.Session service

List of Properties in the Session Service SCRIPTISAPPLICATION
SCRIPTISEMBEDDED
SCRIPTISOXT SCRIPTISPERSONAL
SCRIPTISPERSOXT

 SCRIPTISSHARED
SCRIPTISSHAROXT

ScriptForge.String service

List of Properties in the Dictionary Service sfCR
sfLF sfCRLF
sfNEWLINE sfTAB

ScriptForge.TextStream service

List of Properties in the TextStream Service AtEndOfStream
Encoding
 FileName
IOMode
 Line
NewLine

ScriptForge.Timer service

List of Methods in the Timer Service Continue
Restart Start
Suspend Terminate
List of Properties in the Timer Service Duration
IsStarted IsSuspended
SuspendDuration TotalDuration

ScriptForge.Toolbar service

List of Properties in the Toolbar Service BuiltIn
Docked
HasGlobalScope
 Name
ResourceURL

 Visible
XUIElement

ScriptForge.ToolbarButton service

List of Properties in the ToolbarButton Service Caption
Height
Index
OnClick
 Parent
TipText
Visible

 Width
X
Y

ScriptForge.UI service

List of Properties in the UI Service ActiveWindow
Height
MACROEXECALWAYS
 MACROEXECNEVER
MACROEXECNORMAL
Width
 X
Y

ScriptForge.UnitTest service

List of Properties in the UnitTest Service LongMessage
ReturnCode Verbose

 WhenAssertionFails

ScriptForge.Writer service