Sumário

# Lista de todos os métodos e propriedades de ScriptForge

Esta página de ajuda mostra todos os métodos e propriedades disponíveis na biblioteca ScriptForge por serviço com links para a documentação correspondente.

O código-fonte Basic para todos os serviços ScriptForge está disponível em Macros da aplicação e diálogos e distribuído em várias bibliotecas: ScriptForge, SFDatabases, SFDialogs, SFDocuments, SFUnitTests e SFWidgets. A parte Python do código-fonte está disponível no arquivo program\scriptforge.py no diretório de instalação do LibreOffice.

## Serviço ScriptForge.Array

Lista de Métodos no Serviço 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

## Serviço SFDocuments.Base

Lista de métodos do serviço Base
CloseFormDocument FormDocuments Forms GetDatabase | IsLoaded OpenFormDocument OpenQuery OpenTable | PrintOut SetPrinter

Este serviço também suporta os métodos e propriedades definidos no serviço Document, que inclui métodos que são genéricos para todos os tipos de documentos.

## Serviço ScriptForge.Basic

Lista de Métodos no Serviço 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

Lista de propriedades no serviço 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

## Serviço SFDocuments.Calc

Lista de Métodos no Serviço 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

Lista de propriedades no serviço Calc
CurrentSelection FirstCell FirstColumn FirstRow Height LastCell | LastColumn LastRow Range Region Sheet SheetName | Sheets Width XCellRange XSheetCellCursor XSpreadsheet

Este serviço também suporta os métodos e propriedades definidos no serviço Document, que inclui métodos que são genéricos para todos os tipos de documentos.

## Serviço SFDocuments.Chart

Lista de Métodos no Serviço Chart
ExportToFile | Resize

Lista de propriedades no serviço Chart
ChartType Deep Dim3D Exploded Filled | Legend Percent Stacked Title XTitle | YTitle XChartObj XDiagram XShape XTableChart

## Serviço SFDatabases.Database

Lista de Métodos no Serviço Database
CloseDatabase Commit CreateDataset DAvg DCount DMin | DMax DSum DLookup GetRows OpenFormDocument OpenQuery | OpenSql OpenTable Rollback RunSql SetTransactionMode

Lista de propriedades no serviço Database
Queries Tables | XConnection | XMetaData

## Serviço SFDatabases.Dataset

Lista de Métodos no Serviço Dataset
CloseDataset CreateDataset Delete ExportValueToFile GetRows | GetValue Insert MoveFirst MoveLast | MoveNext MovePrevious Reload Update

Lista de propriedades no serviço Dataset
BOF DefaultValues EOF Fields Filter | Orderby ParentDatabase RowCount RowNumber Source | SourceType UpdatableFields Values XRowSet

## Serviço SFDatabases.Datasheet

Lista de Métodos no Serviço Datasheet
Activate CloseDatasheet CreateMenu | GetText GetValue GoToCell | RemoveMenu Toolbars

Lista de propriedades no serviço Datasheet
ColumnHeaders CurrentColumn CurrentRow DatabaseFileName Filter | LastRow OrderBy ParentDatabase Source | SourceType XComponent XControlModel XTabControllerModel

## Serviço SFDialogs.Dialog

Lista de métodos do serviço 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

Lista de propriedades no serviço 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

## Serviço SFDialogs.DialogControl

Lista de Métodos no Serviço DialogControl
AddSubNode AddSubTree CreateRoot | FindNode Resize SetFocus | SetTableData WriteLine

Lista de propriedades no serviço 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

## Serviço ScriptForge.Dictionary

Lista de métodos no serviço Dictionary
Add ConvertToArray ConvertToJson ConvertToPropertyValues | Exists ImportFromJson ImportFromPropertyValues Item | Remove RemoveAll ReplaceItem ReplaceKey

Lista de propriedades no serviço Dictionary
Count | Items | Keys

## Serviço SFDocuments.Document

Lista de Métodos do Serviço Document
Activate CloseDocument CreateMenu DeleteStyles Echo ExportAsPDF | ImportStylesFromFile PrintOut RemoveMenu RunCommand Save SaveAs | SaveCopyAs SetPrinter Style Toolbars XStyle

Lista de propriedades no serviço Document
CustomProperties Description DocumentProperties DocumentType ExportFilters FileSystem ImportFilters | IsBase IsCalc IsDraw IsFormDocument IsImpress IsMath IsWriter | Keywords Readonly StyleFamilies Subject Title XComponent XDocumentSettings

## Serviço ScriptForge.Exception

Lista de métodos no serviço Exception
Clear Console ConsoleClear ConsoleToFile | DebugDisplay DebugPrint PythonPrint | PythonShell Raise RaiseWarning

Lista de propriedades no serviço Exception
Description | Number | Source

## Serviço ScriptForge.FileSystem

Lista de Métodos no Serviço 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

Lista de propriedades no serviço FileSystem
ConfigFolder ExtensionsFolder FileNaming HomeFolder | InstallFolder Subject TemplatesFolder TemporaryFolder | Title UserTemplatesFolder XComponent

## Serviço SFDocuments.Form

Lista de Métodos no Serviço Form
Activate CloseFormDocument Controls GetDatabase | MoveFirst MoveLast MoveNext MoveNew | MovePrevious Requery SubForms

Lista de propriedades no serviço 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

## Serviço SFDocuments.FormControl

Lista de Métodos no Serviço FormControl
Controls | SetFocus

Lista de propriedades no serviço 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

## Serviço SFDocuments.FormDocument

Lista de Métodos do Serviço FormDocument
CloseDocument | Forms | PrintOut

## Serviço ScriptForge.L10N

Lista de Métodos no Serviço L10N
AddText AddTextsFromDialog | ExportToPOTFile | GetText

Lista de propriedades no serviço L10N
Folder | Language | Locale

## Serviço SFWidgets.Menu

Lista de métodos do serviço Menu
AddCheckBox | AddItem | AddRadioButton

Lista de propriedades no serviço Menu
ShortcutCharacter | SubmenuCharacter

## Serviço ScriptForge.Platform

Lista de propriedades no serviço Platform
Architecture ComputerName CPUCount CurrentUser Extensions FilterNames Fonts | FormatLocale Locale Machine OfficeLocale OfficeVersion OSName OSPlatform | OSRelease OSVersion Printers Processor PythonVersion SystemLocale UserData

## Serviço SFWidgets.PopupMenu

Lista de Métodos do Serviço PopupMenu
AddCheckBox AddItem | AddRadioButton | Execute

Lista de propriedades no serviço PopupMenu
ShortcutCharacter | SubmenuCharacter

## Serviço ScriptForge.Region

Lista de Métodos no Serviço Region
DSTOffset LocalDateTime | Number2Text TimeZoneOffset | UTCDateTime UTCNow

Lista de propriedades no serviço Region
Country Currency DatePatterns DateSeparator DayAbbrevNames | DayNames DayNarrowNames DecimalPoint Language ListSeparator | MonthAbbrevNames MonthNames MonthNarrowNames ThousandSeparator TimeSeparator

## Serviço ScriptForge.Session

Lista de Métodos do Serviço Session
ExecuteBasicScript ExecuteCalcFunction ExecutePythonScript GetPDFExportOptions HasUnoMethod | HasUnoProperty OpenURLInBrowser RunApplication SendMail SetPDFExportOptions | UnoMethods UnoProperties UnoObjectType WebService

Lista de propriedades no serviço Session
SCRIPTISAPPLICATION SCRIPTISEMBEDDED SCRIPTISOXT | SCRIPTISPERSONAL SCRIPTISPERSOXT | SCRIPTISSHARED SCRIPTISSHAROXT

## Serviço ScriptForge.String

Lista de Métodos no Serviço 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

Lista de propriedades no serviço Dictionary
sfCR sfLF | sfCRLF sfNEWLINE | sfTAB

## Serviço ScriptForge.TextStream

Lista de Métodos no Serviço TextStream
CloseFile ReadAll | ReadLine SkipLine | WriteBlankLines WriteLine

Lista de propriedades no serviço TextStream
AtEndOfStream Encoding | FileName IOMode | Line NewLine

## Serviço ScriptForge.Timer

Lista de métodos do serviço Timer
Continue Restart | Start Suspend | Terminate

Lista de propriedades no serviço Timer
Duration IsStarted | IsSuspended SuspendDuration | TotalDuration

## Serviço ScriptForge.Toolbar

Lista de métodos do serviço Toolbar
ToolbarButtons |  |

Lista de propriedades no serviço Toolbar
BuiltIn Docked HasGlobalScope | Name ResourceURL | Visible XUIElement

## Serviço ScriptForge.ToolbarButton

Lista de Métodos no Serviço ToolbarButton
Execute |  |

Lista de propriedades no serviço ToolbarButton
Caption Height Index OnClick | Parent TipText Visible | Width X Y

## Serviço ScriptForge.UI

Lista de Métodos no Serviço UI
Activate CreateBaseDocument CreateDocument (*) GetDocument Maximize | Minimize OpenBaseDocument OpenDocument (*) Resize | RunCommand SetStatusBar (*) ShowProgressBar WindowExists

Lista de propriedades no serviço UI
ActiveWindow Documents Height | MACROEXECALWAYS MACROEXECNEVER MACROEXECNORMAL | Width X Y

## Serviço ScriptForge.UnitTest

Lista de métodos no serviço 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

Lista de propriedades no serviço UnitTest
LongMessage ReturnCode | Verbose | WhenAssertionFails

## Serviço ScriptForge.Writer

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

Tópicos relacionados

A Biblioteca ScriptForge

Criando Scripts Python com o ScriptForge