Contenu

# Liste de toutes les méthodes et propriétés ScriptForge

Cette page d'aide présente toutes les méthodes et propriétés disponibles dans la bibliothèque ScriptForge par service avec des liens vers la documentation correspondante.

Le code source Basic de tous les services ScriptForge est disponible via Application Macros et boîtes de dialogue et est distribué dans plusieurs bibliothèques : ScriptForge, SFDatabases, SFDialogs, SFDocuments, SFUnitTests et SFWidgets. La partie Python du code source est disponible dans le fichier program\scriptforge.py sous le répertoire d'installation LibreOffice.

## Service ScriptForge.Array

Liste des méthodes dans le service 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

## Service SFDocuments.Base

Liste des méthodes dans le service Base
CloseFormDocument FormDocuments Forms GetDatabase | IsLoaded OpenFormDocument OpenQuery OpenTable | PrintOut SetPrinter

Ce service prend également en charge les méthodes et propriétés définies dans le service Document, qui inclut des méthodes génériques pour tous types de documents.

## Service ScriptForge.Basic

Liste des méthodes dans le service 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

Liste des propriétés dans le service 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

## Service SFDocuments.Calc

Liste des méthodes dans le service 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
InsertSheet
MoveRange
MoveSheet
Offset

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

Liste des propriétés dans le service Calc
CurrentSelection FirstCell FirstColumn FirstRow Height LastCell | LastColumn LastRow Range Region Sheet SheetName | Sheets Width XCellRange XSheetCellCursor XSpreadsheet

Ce service prend également en charge les méthodes et propriétés définies dans le service Document, qui inclut des méthodes génériques pour tous types de documents.

## Service SFDocuments.Chart

Liste des méthodes dans le service Chart
ExportToFile | Resize

Liste des propriétés dans le service Chart
ChartType Deep Dim3D Exploded Filled | Legend Percent Stacked Title XTitle | YTitle XChartObj XDiagram XShape XTableChart

## Service SFDatabases.Database

Liste des méthodes dans le service Database
CloseDatabase Commit CreateDataset DAvg DCount DMin | DMax DSum DLookup GetRows OpenFormDocument OpenQuery | OpenSql OpenTable Rollback RunSql SetTransactionMode

Liste des propriétés dans le service Database
Queries Tables | XConnection | XMetaData

## Service SFDatabases.Dataset

Liste des méthodes dans le service Dataset
CloseDataset CreateDataset Delete ExportValueToFile GetRows | GetValue Insert MoveFirst MoveLast | MoveNext MovePrevious Reload Update

Liste des propriétés dans le service Dataset
BOF DefaultValues EOF Fields Filter | Orderby ParentDatabase RowCount RowNumber Source | SourceType UpdatableFields Values XRowSet

## Service SFDatabases.Datasheet

Liste des méthodes dans le service Datasheet
Activate CloseDatasheet CreateMenu | GetText GetValue GoToCell | RemoveMenu Toolbars

Liste des propriétés dans le service Datasheet
ColumnHeaders CurrentColumn CurrentRow DatabaseFileName Filter | LastRow OrderBy ParentDatabase Source | SourceType XComponent XControlModel XTabControllerModel

## Service SFDialogs.Dialog

Liste des méthodes dans le service Dialog

Activate
Center
Controls
CloneControl
CreateButton
CreateCheckBox
CreateComboBox
CreateCurrencyField
CreateDateField
CreateFileControl
CreateFixedLine

CreateFixedText
CreateFormattedField
CreateGroupBox
CreateHyperlink
CreateImageControl
CreateListBox
CreateNumericField
CreatePatternField
CreateProgressBar
CreateRadioButton
CreateScrollBar

CreateTableControl
CreateTextField
CreateTimeField
CreateTreeControl
EndExecute
Execute
GetTextsFromL10N
Resize
OrderTabs
SetPageManager
Terminate

Liste des propriétés dans le service 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

## Service SFDialogs.DialogControl

Liste des méthodes dans le service DialogControl
AddSubNode AddSubTree CreateRoot | FindNode Resize SetFocus | SetTableData WriteLine

Liste des propriétés dans le service 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

## Service ScriptForge.Dictionary

Liste des méthodes dans le service Dictionary
Add ConvertToArray ConvertToJson ConvertToPropertyValues | Exists ImportFromJson ImportFromPropertyValues Item | Remove RemoveAll ReplaceItem ReplaceKey

Liste des propriétés dans le service Dictionnary
Count | Items | Keys

## Service SFDocuments.Document

Liste des méthodes dans le service Document
Activate CloseDocument CreateMenu DeleteStyles Echo ExportAsPDF | ImportStylesFromFile PrintOut RemoveMenu RunCommand Save SaveAs | SaveCopyAs SetPrinter Style Toolbars XStyle

Liste des propriétés dans le service Document
CustomProperties Description DocumentProperties DocumentType ExportFilters FileSystem ImportFilters | IsBase IsCalc IsDraw IsFormDocument IsImpress IsMath IsWriter | Keywords Readonly StyleFamilies Subject Title XComponent XDocumentSettings

## Service ScriptForge.Exception

Liste des méthodes dans le service Exception
Clear Console ConsoleClear ConsoleToFile | DebugDisplay DebugPrint PythonPrint | PythonShell Raise RaiseWarning

Liste des propriétés dans le service Exception
Description | Number | Source

## Service ScriptForge.FileSystem

Liste des méthodes dans le service 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

Liste des propriétés dans le service FileSystem
ConfigFolder ExtensionsFolder FileNaming HomeFolder | InstallFolder Subject TemplatesFolder TemporaryFolder | Title UserTemplatesFolder XComponent

## Service SFDocuments.Form

Liste des méthodes dans le service Form
Activate CloseFormDocument Controls GetDatabase | MoveFirst MoveLast MoveNext MoveNew | MovePrevious Requery SubForms

Liste des propriétés dans le service 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

## Service SFDocuments.FormControl

Liste des méthodes dans le service FormControl
Controls | SetFocus

Liste des propriétés dans le service 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

## Service SFDocuments.FormDocument

Liste des méthodes dans le service formDocument
CloseDocument | Forms | PrintOut

## Service ScriptForge.L10N

Liste des méthodes dans le service L10N
AddText AddTextsFromDialog | ExportToPOTFile | GetText

Liste des propriétés dans le service L10N
Folder | Language | Locale

## Service SFWidgets.Menu

Liste des méthodes dans le service Menu
AddCheckBox | AddItem | AddRadioButton

Liste des propriétés dans le service Menu
ShortcutCharacter | SubmenuCharacter

## Service ScriptForge.Platform

Liste des propriétés dans le service PlatForm
Architecture ComputerName CPUCount CurrentUser Extensions FilterNames Fonts | FormatLocale Locale Machine OfficeLocale OfficeVersion OSName OSPlatform | OSRelease OSVersion Printers Processor PythonVersion SystemLocale UserData

## Service SFWidgets.PopupMenu

Liste des méthodes dans le service PopupMenu
AddCheckBox AddItem | AddRadioButton | Execute

Liste des propriétés dans le service PopupMenu
ShortcutCharacter | SubmenuCharacter

## Service ScriptForge.Region

Liste des méthodes dans le service Region
DSTOffset LocalDateTime | Number2Text TimeZoneOffset | UTCDateTime UTCNow

Liste des propriétés dans le service Region
Country Currency DatePatterns DateSeparator DayAbbrevNames | DayNames DayNarrowNames DecimalPoint Language ListSeparator | MonthAbbrevNames MonthNames MonthNarrowNames ThousandSeparator TimeSeparator

## Service ScriptForge.Session

Liste des méthodes dans le service Session
ExecuteBasicScript ExecuteCalcFunction ExecutePythonScript GetPDFExportOptions HasUnoMethod | HasUnoProperty OpenURLInBrowser RunApplication SendMail SetPDFExportOptions | UnoMethods UnoProperties UnoObjectType WebService

Liste des propriétés dans le service Session
SCRIPTISAPPLICATION SCRIPTISEMBEDDED SCRIPTISOXT | SCRIPTISPERSONAL SCRIPTISPERSOXT | SCRIPTISSHARED SCRIPTISSHAROXT

## Service ScriptForge.String

Liste des méthodes dans le service 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

Liste des propriétés dans le service Dictionnary
sfCR sfLF | sfCRLF sfNEWLINE | sfTAB

## Service ScriptForge.TextStream

Liste des méthodes dans le service textStream
CloseFile ReadAll | ReadLine SkipLine | WriteBlankLines WriteLine

Liste des propriétés dans le service TextStream
AtEndOfStream Encoding | FileName IOMode | Line NewLine

## Service ScriptForge.Timer

Liste des méthodes dans le service Timer
Continue Restart | Start Suspend | Terminate

Liste des propriétés dans le service Timer
Duration IsStarted | IsSuspended SuspendDuration | TotalDuration

## Service ScriptForge.Toolbar

Liste des méthodes dans le service Toolbar
ToolbarButtons |  |

Liste des propriétés dans le service Toolbar
BuiltIn Docked HasGlobalScope | Name ResourceURL | Visible XUIElement

## Service ScriptForge.ToolbarButton

Liste des méthodes dans le service ToolbarButton
Execute |  |

Liste des propriétés dans le service ToolbarButton
Caption Height Index OnClick | Parent TipText Visible | Width X Y

## Service ScriptForge.UI

Liste des méthodes dans le service UI
Activate CreateBaseDocument CreateDocument (*) GetDocument Maximize | Minimize OpenBaseDocument OpenDocument (*) Resize | RunCommand SetStatusBar (*) ShowProgressBar WindowExists

Liste des propriétés dans le service UI
ActiveWindow Documents Height | MACROEXECALWAYS MACROEXECNEVER MACROEXECNORMAL | Width X Y

## Service ScriptForge.UnitTest

Liste des méthodes dans le service the 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

Liste des propriétés dans le service UnitTest
LongMessage ReturnCode | Verbose | WhenAssertionFails

## Service ScriptForge.Writer

D'oh! You found a bug (text/sbasic/shared/03/sf_writer.xhp#methods_toc not found).

Rubriques connexes

La bibliothèque ScriptForge

Créer des scripts Python avec ScriptForge