Contents

# 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 LibreOfficeDev installation directory.

## ScriptForge.Array service

List of Methods in the Array Service
Append AppendColumn AppendRow Contains ConvertFromDataArray ConvertToDataArray ConvertToDictionary ConvertToRange Copy CountDims Difference ExportToTextFile | ExtractColumn ExtractRow Flatten ImportFromCSVFile IndexOf Insert InsertSorted Intersection Join2D Prepend PrependColumn PrependRow | RangeInit Reverse Shuffle Slice Sort SortColumns SortRows Transpose TrimArray Union Unique

## SFDocuments.Base service

List of Methods in the Base Service
CloseFormDocument FormDocuments Forms GetDatabase | IsLoaded OpenFormDocument OpenQuery OpenTable | PrintOut SetPrinter

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 Methods in the Basic Service
CDate CDateFromUnoDateTime CDateToUnoDateTime ConvertFromUrl (*) ConvertToUrl (*) CreateUnoService CreateUnoStruct (*) DateAdd | DateDiff DatePart DateValue Format GetDefaultContext GetGuiType (*) GetPathSeparator (*) GetSystemTicks | GlobalScope.BasicLibraries GlobalScope.DialogLibraries InputBox (*) MsgBox (*) Now RGB Xray

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 Methods in the Calc Service
A1Style Activate AlignRange BorderRange Charts ClearAll ClearFormats ClearValues ColorizeRange CompactLeft CompactUp CopySheet CopySheetFromFile CopyToCell CopyToRange CreateChart CreatePivotTable DAvg | DCount DecorateFont DefineName DMax DMin DSum ExportRangeToFile FormatRange Forms GetColumnName GetFormula GetValue ImportFromCSVFile ImportFromDatabase ImportStylesFromFile InsertSheet Intersect MoveRange | MoveSheet Offset OpenRangeSelector PrintOut Printf RemoveDuplicates RemoveSheet RenameSheet SetArray SetCellStyle SetFormula SetValue ShiftDown ShiftLeft ShiftRight ShiftUp SortRange

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

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

## SFWidgets.ContextMenu service

List of Methods in the ContextMenu Service
Activate | AddItem | RemoveAllItems

List of Properties in the ContextMenu Service
ShortcutCharacter | SubmenuCharacter

## SFDocuments.Chart service

List of Methods in the Chart Service
ExportToFile | Resize

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 Methods in the Database Service
CloseDatabase Commit CreateDataset DAvg DCount DMin | DMax DSum DLookup GetRows OpenFormDocument OpenQuery | OpenSql OpenTable Rollback RunSql SetTransactionMode

List of Properties in the Database Service
Queries Tables | XConnection | XMetaData

## SFDatabases.Dataset service

List of Methods in the Dataset Service
CloseDataset CreateDataset Delete ExportValueToFile GetRows | GetValue Insert MoveFirst MoveLast | MoveNext MovePrevious Reload Update

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 Methods in the Datasheet Service
Activate CloseDatasheet CreateMenu | GetText GetValue GoToCell | RemoveMenu Toolbars

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 Methods in the Dialog Service
Activate Center Controls CloneControl CreateButton CreateCheckBox CreateComboBox CreateCurrencyField CreateDateField CreateFileControl CreateFixedLine CreateFixedText | CreateFormattedField CreateGroupBox CreateHyperlink CreateImageControl CreateListBox CreateNumericField CreatePatternField CreateProgressBar CreateRadioButton CreateScrollBar CreateTableControl CreateTabPageContainer | CreateTextField CreateTimeField CreateTreeControl EndExecute Execute GetTextsFromL10N ImportControl OrderTabs Resize SetPageManager Terminate

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 Methods in the DialogControl Service
AddSubNode AddSubTree CreateRoot | FindNode Resize SetFocus | SetTableData WriteLine

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 Methods in the Dictionary Service
Add ConvertToArray ConvertToJson ConvertToPropertyValues | Exists ImportFromJson ImportFromPropertyValues Item | Remove RemoveAll ReplaceItem ReplaceKey

List of Properties in the Dictionary Service
Count | Items | Keys

## SFDocuments.Document service

List of Methods in the Document Service
Activate CloseDocument ContextMenus CreateMenu DeleteStyles Echo | ExportAsPDF PrintOut RemoveMenu RunCommand Save SaveAs | SaveCopyAs SetPrinter Style Toolbars XStyle

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 Methods in the Exception Service
Clear Console ConsoleClear ConsoleToFile | DebugDisplay DebugPrint PythonPrint | PythonShell Raise RaiseWarning

List of Properties in the Exception Service
Description | Number | Source

## ScriptForge.FileSystem service

List of Methods in the FileSystem Service
BuildPath CompareFiles CopyFile CopyFolder CreateFolder CreateTextFile DeleteFile DeleteFolder ExtensionFolder | FileExists Files FolderExists GetBaseName GetExtension GetFileLen GetFileModified GetName GetParentFolderName | GetTempName HashFile MoveFile MoveFolder Normalize OpenTextFile PickFile PickFolder SubFolders

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

## SFDocuments.Form service

List of methods in the Form service
Activate Controls GetDatabase MoveFirst | MoveLast MoveNext MoveNew | MovePrevious Requery SubForms

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 Methods in the FormControl Service
Controls | SetFocus

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

List of Methods in the FormDocument Service
CloseDocument Forms | GetDatabase | PrintOut

## ScriptForge.L10N service

List of Methods in the L10N Service
AddText AddTextsFromDialog | ExportToPOTFile | GetText

List of Properties in the L10N Service
Folder | Language | Locale

## SFWidgets.Menu service

List of Methods in the Menu Service
AddCheckBox | AddItem | AddRadioButton

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 Methods in the PopupMenu Service
AddCheckBox AddItem | AddRadioButton | Execute

List of Properties in the PopupMenu Service
ShortcutCharacter | SubmenuCharacter

## ScriptForge.Region service

List of Methods in the Region Service
DSTOffset LocalDateTime | Number2Text TimeZoneOffset | UTCDateTime UTCNow

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 Methods in the Session Service
ExecuteBasicScript ExecuteCalcFunction ExecutePythonScript GetPDFExportOptions HasUnoMethod | HasUnoProperty OpenURLInBrowser RunApplication SendMail SetPDFExportOptions | UnoMethods UnoProperties UnoObjectType WebService

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

## ScriptForge.String service

List of Methods in the String Service
Capitalize Count EndsWith Escape ExpandTabs FilterNotPrintable FindRegex HashStr HtmlEncode IsADate IsAlpha IsAlphaNum IsAscii IsDigit IsEmail | IsFileName IsHexDigit IsIBAN IsIPv4 IsLike IsLower IsPrintable IsRegex IsSheetName IsTitle IsUpper IsUrl IsWhitespace JustifyCenter JustifyLeft | JustifyRight Quote ReplaceChar ReplaceRegex ReplaceStr Represent Reverse SplitLines SplitNotQuoted StartsWith TrimExt Unescape Unquote Wrap

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

## ScriptForge.TextStream service

List of Methods in the TextStream Service
CloseFile ReadAll | ReadLine SkipLine | WriteBlankLines WriteLine

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 Methods in the Toolbar Service
ToolbarButtons |  |

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

## ScriptForge.ToolbarButton service

List of Methods in the ToolbarButton Service
Execute |  |

List of Properties in the ToolbarButton Service
Caption Height Index OnClick | Parent TipText Visible | Width X Y

## ScriptForge.UI service

List of Methods in the UI Service
Activate CreateBaseDocument CreateDocument (*) Documents GetDocument | Maximize Minimize OpenBaseDocument OpenDocument (*) Resize | RunCommand SetStatusBar (*) ShowProgressBar WindowExists

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

## ScriptForge.UnitTest service

List of Methods in the UnitTest Service
AssertAlmostEqual AssertEqual AssertFalse AssertGreater AssertGreaterEqual AssertIn AssertIsInstance AssertIsNothing AssertLike | AssertNotRegex AssertIsNull AssertLess AssertLessEqual AssertNotAlmostEqual AssertNotEqual AssertNotIn AssertNotInstance AssertNotLike | AssertNotNothing AssertNotNull AssertRegex AssertTrue Fail Log ReportError RunTest SkipTest

List of Properties in the UnitTest Service
LongMessage ReturnCode | Verbose | WhenAssertionFails

## ScriptForge.Writer service

List of Methods in the Writer Service
Forms | ImportStylesFromFile | PrintOut

Related Topics

The ScriptForge Library

Creating Python Scripts with ScriptForge

Please support us!