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 Wait 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

PickFolder
SubFolders

ol Service

<[O rowspan="" colspan="" dir="auto">

Controls

RootNode
<[O rowspan="" colspan="" dir="auto">

/a>

List of Properties in the FormControl Service

69Control Service

br> Value
/a>

br> UserTemplatesFolder
tr>

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 OnApproveUpded/03/sf_dialogcontrol.html#properties_toc">XControlView "1561096a> ControlType OnApproveUpded/03/sf_dialogcontrol.html#properties_toc">XControlView
RootNode

	XForm
51612709117248" class="tablecontentintable" dir="auto"> /a>
i/text/sbasic/shared/03/sf_formcontrol.html#properties_toc">Name 07L]owspan="" colspan="" dir="auto"> /a>
List of Properties in the Document Service felass="tableheadintable" dir="auto">Basic IDE Description
OnApproveU>

Description

FileNamiScriptForge.Exception service

30 "00803" class="tablecontentintable" dir="auto"> OnApproveReset
ge.Exception service

30 "00803" class="tablecontentintable" dir="auto"> )e

Cancel

OnItemStateChanged

SaveCopyAs
SetPrinter
Forms can be accessed by their names or by their indices, as shown below:


     Set myForm = oDoc.Forms(0)

OnKeyReleased
target="_top" href="fi/text/sbasic/shared/03/sf_dialogcontrol.html#properties_toc">Value
tentintable" dir="auto">No

Key released

OnMouseDragged

No
target="_top" hre"fi/text/sbasic/shared,03/sf_for_.html#properties_toc">Name

List of Methods in the FormDocument" dir="auto"> /a <_dataset.html#properties_toc">BOF
DefaultValues

In Basic

HashFile

             
                FileNamiScriptForge.Exception service
  
         
      
      
         

      30 "00803" class="tablecontenti             HashFile

             CopyFile

             FileNamiScriptForge.Exception service
  
         
      
      
         

      30 "00803" cl2629836630" class="�_toc">DefaultValuesFileNami
      
        
    

UserTemplatesFolder

OnKeyReleased
    '6   
    target="_top" href="fi/text/sbasic/shared/03/sf_dialogcontrol.html#properties_toc">Value

   tentintable" dir="auto">No
         
         
            CopyFile

             O

    

UserTemplatesFolder

   

      30 "00803" class="tablecontentintable" dir="auto">
            OnApproveReset

            ge.Exception service
  
         
      

      30 "00803" class="tablecontentintable" dir  
      

      30 "00803" class="tablecontentintable" dir="auto">
            OnApproveReset

            ge.Exception service
  
         
      

      30 "00803" class="tablecontentintable" dir  
      

      30 "00803" class="tablecontentintable" dir="auto">
            OnApproveReset

            ge.
            

   ConsoleClear

        adding="0" cellspacing="0">
    

      30 "00803" class="tablecontenti             HashFile

             No
         
         

      30 "00803" class="tablecontentintable" dir="auto">
            OnApprovConsoleClear

        add  

      


      30 "00803" classunctsyntax">

            



   
    
      UserTemplatesFolder
   MoveFolder
type="http://schema.org/SoftwareSourceCoxt/sbasic/shared/03/sf_document.html#SaveCopyAs">SaveCopyAs

             
    

      UserTemplatesFolder
   
    

      UserTemplatesFolderException service
  
         
      
      
         
      
         
      
         
      
         
      
         

      Exception service
  
         
      
      
         PickFile

          '
        adding="0" cellspacing="0">
    

      Exception servicwkr>
        
          
      
      
         
      
         

    
      
            
    
    
    ConsoleClear

    d="functsyntax">

         
      
      


      30 "00803" class="tablecontentintable" dir="auto">iant
         
        
    target="_top" href="fi/text/sbasic/shared/03/sf_dialogcontrol.html#properties_code" itemscope="true" itemtype="http://schema.org/SoftwareSourceCode" itemprop="codeSampleType" content="snippet" data-tooltip="Napsauta tekstiä kopioidaksesi sen leikepöydälle">
      oMenu.AddRadioButton("Item A", name="A", status=True)
    


      

All 
         
         
   ctivate forms.
Open and activate forms.
    

           ared/03/sf_form.html#properties_toc">Filter

            

        ol Service
        
      
   ctivate for'', includesubfolders: bool = False): str[0..*]
    
 emprop="itemem" dir="auto">Open and activate forms.
    

    

           ared/03/sf_form.html#properties_toc">Filter

            

        ol Service
     )90" colspan="" dir="auto">
            Loci itemprop="it            
  
columndelims\ib: Delimits each column (default = Tab/Chr(9)).

  rowdelimiter: Delimits each row (default = LineFeed/Chr(10))
  
Loci itemprop="it            rowdelimiter: Delim  
sfCRLF
          ode>
  

  

      
3ce,SubmenuCharacter">
 
    
sfCRLF
          
      ,60ntrol.html#Controls">Controls

          
       
       
         
      
   ctivate for'', includesubfolders: bool = False): str[0..*]
 emprop="itemem" dir="auto">Open and activate forms.

    

           ared/03/sf_form.html#properties_toc">Filter

            

        ol      

            
         
         
            This property depends on the current control type. Refer to The Value property for more information.
         
      
      
         
UserTemplatesFolder

OnKeyReleased
    '6   
  

  
            Yes
         
         
            

    
SFWidgets.ContextMenu service
    SFWidgets.PopupMenu service
    SFDocuments.Document service
  


 service<.org/ItemList" dir="auto">
    

        Open and activate forms.
    

    
        
         
            Open and activate forms.
    
    PickFolderter: str = '', includesubfolders: bool = False): str[0..*]
    
 emprop="itemListElement" itemscope="true" itemtype="http://schema.org/Ie�ӳistUnordered" dir="auto">
        Open and activate forms.
    
    
        
         
            Open and activate forms.
    
    
           ared/03/sf_form.html#properties_toc">Filter

            

        ol Service
        
      
    
    
    
    
    
          
      oMenu.AddRadioButton("Item A", name="A", status=True)
    
  

  


      
3ce,SubmenuCharacter">
 
    

      

      
      
         
            OnFocusGained
         
         
            No
         
         
            When receiving focus
         
      
      
         
            OnFocusLost
         
         
            No
         
         
            When loid921613595637851" class="paragraph" dir="auto">Consider the text file "Students.txt" with the following conten" class="tablecontentintable" dir="auto">When receiving focus
  6286" class="tablecontenti_tiiem" dir="auto">Open and activate forms.
    
  fi/text/sbasic/shared/03/sf_dialogcontrol.html#properties_toc">Cancel

            
            
          OnItemStateChanged
         
         
            
             SaveCopyAs

             SetPrinter

             
      
    
    
    
    
        List of Properties in the Document Service
        felass="tableheadintable" dir="auto">Basic IDE Description
         
      
      
         
            
Because Python has comprehensive built-in string support, most of the methods in the String service are available for Basic scripts oopioidakse="modules-nav" hidden="">

"_top" href="fi/text/sbasic/share8" class="tablecontentintable"app:"WRITER", text:"muine-numbers">
      oMenu.AddRadioButclle" dir="auto">OnFocusGained_e067008842" class="paragraph" dir="auto">rowdelimiter: Delimits each row (default = LineFeed/Chr(10))
  
Loci itemprop="it            rowdelimiternabled

            
            
        

       
  ed

            
      /a>


          
      

        

            columndelims\ib: Delimits each column (default = Tab/Chr(9)).
  rowdelimiter: Delimits each row (default = LineFeed/Chr(10))
  
Loci itemprop="it            rowdelimiter: Delimits each row (default = LineFeed/Chr(10))
  
    
   ctivate for'', includesubfolders: bool = False): str[0..*]
 emprop="itemem" dir="auto">Open and activate forms.
OnApproveReset

            ge
      /a       <_dataset,6tml#dboperties_toc">BOF

            Basic IDE Description
         
      
      

   td>
    target="_to class="input" data-tooltip="Napsauta tekstiä kopioidaksesi sen leikepöydälle">$ python.exe
      Locked

            Esimerkki:

  



<_top" href="fi/text/sbasdt')
     my_form = doc.Forms('Form1')
   

            HashFile

             Covisual-basic "_top" href="fi/text/sbasic/shared/03/sf_dictionary.html#properties_toc">Keys

          
      is method also accepts the following formats:
    OnMouseDragged
         
 d/03/sf_filesystem.html#properties_toc">UserTemplatesFolder

             HashFile

             Covisual-basic "_top" href="fi/text/sbasic/shared/03/sf_dictionary.html#properties_toc">Keys

          
      is method also accepts the following fointable" dir  
      


      30 "mscope="true" itemtype="http://scheop" href="fi/text/sbasic/shared/03/sOnMouseDragged
html#MoveFolder">MoveFolder
type="http://schema.org/SoftwareSourceCoxt/sral">Exception
            
             SetPrinter

             Loci itemprop="it            
      
   
         
      
  (3     
      
        Besides using a single msgid string, this method also accepts the following formats:
    
      
        The context string with which the method will retrieve the msgid in the PO file,auto">
           

            
    
Specifies how records in a child subform are linked to records in its parent form.
 "6060entintable" dir="auto">696     ScriptForge.FileSystem href="fi/text/sbasic/shared/03/sf_formcontrol.html#properties_toc">Action

            
     dered" itemscopat="_top" href="fi/text/sbasic/shared/03/sf_document.html#SaveCopyAs">SaveCopyAs

             SetPrinter

             
      
    
    
    
      
         
      
         
            CreateTable" dir="auto">No
         
            Key released
         
      
      
         
            OnMouseDragged

UserTemplatesFolder MoveFolder type="http://schema.org/SoftwareSourceCoxt/sbasic/shared/03/sf_document.html#SaveCopyAs">SaveCopyAs
UserTemplatesFolder
UserTemplatesFolderException service
Exception service
PickFile ' adding="0" cellspacing="0">
Exception servicwkr>

List of all ScriptForge methods and properties

ScriptForge.Array service

SFDocuments.Base service

ScriptForge.Basic service

SFDocuments.Calc service

SFWidgets.ContextMenu service

SFDocuments.Chart service

SFDatabases.Database service

SFDatabases.Dataset service

SFDatabases.Datasheet service

SFDialogs.Dialog service

SFDialogs.DialogControl service

ScriptForge.Dictionary service

SFDocuments.Document service

ScriptForge.Exception service

ScriptForge.FileSystem service

SFDocuments.Form service

SFDocuments.FormControl service

Description FileNamiScriptForge.Exception service

OnKeyReleased target="_top" href="fi/text/sbasic/shared/03/sf_dialogcontrol.html#properties_toc">Value tentintable" dir="auto">No Key released OnMouseDragged No target="_top" hre"fi/text/sbasic/shared,03/sf_for_.html#properties_toc">Name

List of Methods in the FormDocument" dir="auto"> /a <_dataset.html#properties_toc">BOF DefaultValues In Basic

In Basic

OnKeyReleased '6

SFWidgets.ContextMenu service SFWidgets.PopupMenu service SFDocuments.Document service service<.org/ItemList" dir="auto"> Open and activate forms.

Description

FileNamiScriptForge.Exception service

OnKeyReleased
target="_top" href="fi/text/sbasic/shared/03/sf_dialogcontrol.html#properties_toc">Value
tentintable" dir="auto">No

Key released

OnMouseDragged

No
target="_top" hre"fi/text/sbasic/shared,03/sf_for_.html#properties_toc">Name

List of Methods in the FormDocument" dir="auto"> /a <_dataset.html#properties_toc">BOF
DefaultValues

In Basic

OnKeyReleased
'6

SFWidgets.ContextMenu service

SFWidgets.PopupMenu service

SFDocuments.Document service

service<.org/ItemList" dir="auto">

Open and activate forms.