Contingut

# Llista de tots els mètodes i propietats de l'ScriptForge

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 LibreOffice installation directory.

## Servei ScriptForge.Array

Llista de mètodes del servei Array
Append AppendColumn AppendRow Contains ConvertToDictionary 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

## Servei SFDocuments.Base

Llista de mètodes del servei Base
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.

## Servei ScriptForge.Basic

Llista de mètodes del servei Basic
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

Llista de propietats del servei Basic
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

## Servei SFDocuments.Calc

Llista de mètodes del servei Calc

A1Style
Activate
Charts
ClearAll
ClearFormats
ClearValues
CompactLeft
CompactUp
CopySheet
CopySheetFromFile
CopyToCell
CopyToRange
CreateChart
CreatePivotTable
DAvg
DCount

DMax
DMin
DSum
ExportRangeToFile
Forms
GetColumnName
GetFormula
GetValue
ImportFromCSVFile
ImportFromDatabase
ImportStylesFromFile
InsertSheet
MoveRange
MoveSheet
Offset
OpenRangeSelector

PrintOut
Printf
RemoveDuplicates
RemoveSheet
RenameSheet
SetArray
SetCellStyle
SetFormula
SetValue
ShiftDown
ShiftLeft
ShiftRight
ShiftUp
SortRange

Llista de propietats del servei Calc
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.

## Servei SFDocuments.Chart

Llista de mètodes del servei Chart
ExportToFile | Resize

Llista de propietats del servei Chart
ChartType Deep Dim3D Exploded Filled | Legend Percent Stacked Title XTitle | YTitle XChartObj XDiagram XShape XTableChart

## Servei SFDatabases.Database

Llista de mètodes del servei Database
CloseDatabase Commit CreateDataset DAvg DCount DMin | DMax DSum DLookup GetRows OpenFormDocument OpenQuery | OpenSql OpenTable Rollback RunSql SetTransactionMode

Llista de propietats del servei Database
Queries Tables | XConnection | XMetaData

## SFDatabases.Dataset service

Llista de mètodes del servei Dataset
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

## Servei SFDatabases.Datasheet

Llista de mètodes del servei Datasheet
Activate CloseDatasheet CreateMenu | GetText GetValue GoToCell | RemoveMenu Toolbars

Llista de propietats del servei Datasheet
ColumnHeaders CurrentColumn CurrentRow DatabaseFileName Filter | LastRow OrderBy ParentDatabase Source | SourceType XComponent XControlModel XTabControllerModel

## Servei SFDialogs.Dialog

Llista de mètodes del servei Dialog

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

Llista de propietats del servei Dialog
CANCELBUTTON Caption Height Modal Name OKBUTTON OnFocusGained OnFocusLost | OnKeyPressed OnKeyReleased OnMouseDragged OnMouseEntered OnMouseExited OnMouseMoved OnMousePressed OnMouseReleased | Page Visible Width XChartObj XDiagram XDialogModel XDialogView XTableChart

## Servei SFDialogs.DialogControl

Llista de mètodes del servei DialogControl
AddSubNode AddSubTree CreateRoot | FindNode Resize SetFocus | SetTableData WriteLine

Llista de propietats del servei DialogControl
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

## Servei ScriptForge.Dictionary

Llista de mètodes del servei Dictionary
Add ConvertToArray ConvertToJson ConvertToPropertyValues | Exists ImportFromJson ImportFromPropertyValues Item | Remove RemoveAll ReplaceItem ReplaceKey

Llista de propietats del servei Dictionary
Count | Items | Keys

## Servei SFDocuments.Document

Llista de mètodes del servei Document
Activate CloseDocument CreateMenu DeleteStyles Echo ExportAsPDF | PrintOut RemoveMenu RunCommand Save SaveAs | SaveCopyAs SetPrinter Style Toolbars XStyle

Llista de propietats del servei Document
CustomProperties Description DocumentProperties DocumentType ExportFilters FileSystem ImportFilters | IsBase IsCalc IsDraw IsFormDocument IsImpress IsMath IsWriter | Keywords Readonly StyleFamilies Subject Title XComponent XDocumentSettings

## Servei ScriptForge.Exception

Llista de mètodes del servei Exception
Clear Console ConsoleClear ConsoleToFile | DebugDisplay DebugPrint PythonPrint | PythonShell Raise RaiseWarning

Llista de propietats del servei Exception
Description | Number | Source

## Servei ScriptForge.FileSystem

Llista de mètodes del servei FileSystem
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

Llista de propietats del servei FileSystem
ConfigFolder ExtensionsFolder FileNaming HomeFolder | InstallFolder Subject TemplatesFolder TemporaryFolder | Title UserTemplatesFolder XComponent

## Servei SFDocuments.Form

Llista de mètodes del servei Form
Activate Controls GetDatabase MoveFirst | MoveLast MoveNext MoveNew | MovePrevious Requery SubForms

Llista de propietats del servei Form
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

## Servei SFDocuments.FormControl

Llista de mètodes del servei FormControl
Controls | SetFocus

Llista de propietats del servei FormControl

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

## Servei SFDocuments.FormDocument

Llista de mètodes del servei FormDocument
CloseDocument Forms | GetDatabase | PrintOut

## Servei ScriptForge.L10N

Llista de mètodes del servei L10N
AddText AddTextsFromDialog | ExportToPOTFile | GetText

Llista de propietats del servei L10N
Folder | Language | Locale

## Servei SFWidgets.Menu

Llista de mètodes del servei Menu
AddCheckBox | AddItem | AddRadioButton

Llista de propietats del servei Menu
ShortcutCharacter | SubmenuCharacter

## Servei ScriptForge.Platform

Llista de propietats del servei Platform
Architecture ComputerName CPUCount CurrentUser Extensions FilterNames Fonts | FormatLocale Locale Machine OfficeLocale OfficeVersion OSName OSPlatform | OSRelease OSVersion Printers Processor PythonVersion SystemLocale UserData

## Servei SFWidgets.PopupMenu

Llista de mètodes del servei PopupMenu
AddCheckBox AddItem | AddRadioButton | Execute

Llista de propietats del servei PopupMenu
ShortcutCharacter | SubmenuCharacter

## Servei ScriptForge.Region

Llista de mètodes del servei Region
DSTOffset LocalDateTime | Number2Text TimeZoneOffset | UTCDateTime UTCNow

Llista de propietats del servei Region
Country Currency DatePatterns DateSeparator DayAbbrevNames | DayNames DayNarrowNames DecimalPoint Language ListSeparator | MonthAbbrevNames MonthNames MonthNarrowNames ThousandSeparator TimeSeparator

## Servei ScriptForge.Session

Llista de mètodes del servei Session
ExecuteBasicScript ExecuteCalcFunction ExecutePythonScript GetPDFExportOptions HasUnoMethod | HasUnoProperty OpenURLInBrowser RunApplication SendMail SetPDFExportOptions | UnoMethods UnoProperties UnoObjectType WebService

Llista de propietats del servei Session
SCRIPTISAPPLICATION SCRIPTISEMBEDDED SCRIPTISOXT | SCRIPTISPERSONAL SCRIPTISPERSOXT | SCRIPTISSHARED SCRIPTISSHAROXT

## Servei ScriptForge.String

Llista de mètodes del servei String

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

Llista de propietats del servei Dictionary
sfCR sfLF | sfCRLF sfNEWLINE | sfTAB

## Servei ScriptForge.TextStream

Llista de mètodes del servei TextStream
CloseFile ReadAll | ReadLine SkipLine | WriteBlankLines WriteLine

Llista de propietats del servei TextStream
AtEndOfStream Encoding | FileName IOMode | Line NewLine

## Servei ScriptForge.Timer

Llista de mètodes del servei Timer
Continue Restart | Start Suspend | Terminate

Llista de propietats del servei Timer
Duration IsStarted | IsSuspended SuspendDuration | TotalDuration

## ScriptForge.Toolbar service

Llista de mètodes del servei Toolbar
ToolbarButtons |  |

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

## ScriptForge.ToolbarButton service

Llista de mètodes del servei ToolbarButton
Execute |  |

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

## Servei ScriptForge.UI

Llista de mètodes del servei UI
Activate CreateBaseDocument CreateDocument (*) Documents GetDocument | Maximize Minimize OpenBaseDocument OpenDocument (*) Resize | RunCommand SetStatusBar (*) ShowProgressBar WindowExists

Llista de propietats del servei UI
ActiveWindow Height MACROEXECALWAYS | MACROEXECNEVER MACROEXECNORMAL Width | X Y

## Servei ScriptForge.UnitTest

Llista de mètodes del servei UnitTest
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

Llista de propietats del servei UnitTest
LongMessage ReturnCode | Verbose | WhenAssertionFails

## ScriptForge.Writer service

Llista de mètodes del servei Writer
Forms | ImportStylesFromFile | PrintOut

Temes relacionats

La biblioteca ScriptForge

Creating Python Scripts with ScriptForge