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.

ScriptForge.Array service

The source code for the Array service is available in the SF_Array module of the Application Macros and Dialogs - ScriptForge library.

SFDocuments.Base service

The source code for the Base service is available in the SF_Base module of the Application Macros and Dialogs - SFDocuments library.

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
The Basic service is available only in Python and its source code is available in the program\scriptforge.py file under %PRODUCTNAME installation directory.

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

The source code for the Calc service is available in the SF_Calc module of the Application Macros and Dialogs - SFDocuments library.

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
The source code for the Chart service is available in the SF_Chart module of the Application Macros and Dialogs - SFDocuments library.

SFDatabases.Database service

List of Properties in the Database Service Queries
Tables
XConnection

XMetaData

The source code for the Database service is available in the SF_Database module of the Application Macros and Dialogs - SFDatabases library.

SFDatabases.Datasheet service

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

SourceType
XComponent
XControlModel
XTabControllerModel

The source code for the Datasheet service is available in the SF_Datasheet module of the Application Macros and Dialogs - SFDatabases library.

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
XShape
XTableChart

The source code for the Dialog service is available in the SF_Dialog module of the Application Macros and Dialogs - SFDialogs library.

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

The source code for the DialogControl service is available in the SF_DialogControl module of the Application Macros and Dialogs - SFDialogs library.

ScriptForge.Dictionary service

List of Properties in the Dictionary Service Count
Items
Keys
The source code for the Dictionary service is available in the SF_Dictionary module of the Application Macros and Dialogs - ScriptForge library.

SFDocuments.Document service

List of Properties in the Document Service CustomProperties
Description
DocumentProperties
DocumentType
ExportFilters
ImportFilters
IsBase
IsCalc
IsDraw
IsImpress
IsMath
IsWriter
Keywords
Readonly
Subject
Title
XComponent
The source code for the Document service is available in the SF_Document module of the Application Macros and Dialogs - SFDocuments library.

ScriptForge.Exception service

List of Properties in the Exception Service Description
Number
Source
The source code for the Exception service is available in the SF_Exception module of the Application Macros and Dialogs - ScriptForge library.

ScriptForge.FileSystem service

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

The source code for the FileSystem service is available in the SF_FileSystem module of the Application Macros and Dialogs - ScriptForge library.

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

The source code for the FormControl service is available in the SF_Form module of the Application Macros and Dialogs - SFDocuments library.

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

The source code for the FormControl service is available in the SF_FormControl module of the Application Macros and Dialogs - SFDocuments library.

ScriptForge.L10N service

List of Properties in the L10N Service Folder
Language
Locale
The source code for the L10N service is available in the SF_L10N module of the Application Macros and Dialogs - ScriptForge library.

SFWidgets.Menu service

List of Properties in the Menu Service ShortcutCharacter
SubmenuCharacter
The source code for the Menu service is available in the SF_Menu module of the Application Macros and Dialogs - SFWidgets library.

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

The source code for the Platform service is available in the SF_Platform module of the Application Macros and Dialogs - ScriptForge library.

SFWidgets.PopupMenu service

List of Properties in the PopupMenu Service ShortcutCharacter
SubmenuCharacter
The source code for the PopupMenu service is available in the SF_PopupMenu module of the Application Macros and Dialogs - SFWidgets library.

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
The source code for the Region service is available in the SF_Region module of the Application Macros and Dialogs - ScriptForge library.

ScriptForge.Session service

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

SCRIPTISSHARED
SCRIPTISSHAROXT

The source code for the Session service is available in the SF_Session module of the Application Macros and Dialogs - ScriptForge library.

ScriptForge.String service

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

The source code for the String service is available in the SF_String module of the Application Macros and Dialogs - ScriptForge library.

ScriptForge.TextStream service

List of Properties in the TextStream Service AtEndOfStream
Encoding
FileName
IOMode
Line
NewLine
The source code for the TextStream service is available in the SF_TextStream module of the Application Macros and Dialogs - ScriptForge library.

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

The source code for the Timer service is available in the SF_Timer module of the Application Macros and Dialogs - ScriptForge library.

ScriptForge.UI service

List of Properties in the UI Service ActiveWindow
Documents
Height
MACROEXECALWAYS
MACROEXECNEVER
MACROEXECNORMAL
Width
X
Y
The source code for the UI service is available in the SF_UI module of the Application Macros and Dialogs - ScriptForge library.

ScriptForge.UnitTest service

List of Properties in the UnitTest Service LongMessage
ReturnCode
Verbose

WhenAssertionFails

The source code for the UnitTest service is available in the SF_UnitTest module of the Application Macros and Dialogs - SFUnitTests library.