LibreOffice Module wizards (master) 1
Public Member Functions | Static Public Attributes | List of all members
scriptforge.SFDocuments.SF_Calc Class Reference
Inheritance diagram for scriptforge.SFDocuments.SF_Calc:
[legend]
Collaboration diagram for scriptforge.SFDocuments.SF_Calc:
[legend]

Public Member Functions

def ReviewServiceArgs (cls, windowname='')
 
def FirstCell (self, rangename)
 
def FirstColumn (self, rangename)
 
def FirstRow (self, rangename)
 
def Height (self, rangename)
 
def LastCell (self, rangename)
 
def LastColumn (self, rangename)
 
def LastRow (self, rangename)
 
def Range (self, rangename)
 
def Region (self, rangename)
 
def Sheet (self, sheetname)
 
def SheetName (self, rangename)
 
def Width (self, rangename)
 
def XCellRange (self, rangename)
 
def XSheetCellCursor (self, rangename)
 
def XSpreadsheet (self, sheetname)
 
def A1Style (self, row1, column1, row2=0, column2=0, sheetname='~')
 
def Activate (self, sheetname='')
 
def Charts (self, sheetname, chartname='')
 
def ClearAll (self, range, filterformula='', filterscope='')
 
def ClearFormats (self, range, filterformula='', filterscope='')
 
def ClearValues (self, range, filterformula='', filterscope='')
 
def CompactLeft (self, range, wholecolumn=False, filterformula='')
 
def CompactUp (self, range, wholerow=False, filterformula='')
 
def CopySheet (self, sheetname, newname, beforesheet=32768)
 
def CopySheetFromFile (self, filename, sheetname, newname, beforesheet=32768)
 
def CopyToCell (self, sourcerange, destinationcell)
 
def CopyToRange (self, sourcerange, destinationrange)
 
def CreateChart (self, chartname, sheetname, range, columnheader=False, rowheader=False)
 
def CreatePivotTable (self, pivottablename, sourcerange, targetcell, datafields=ScriptForge.cstSymEmpty, rowfields=ScriptForge.cstSymEmpty, columnfields=ScriptForge.cstSymEmpty, filterbutton=True, rowtotals=True, columntotals=True)
 
def DAvg (self, range)
 
def DCount (self, range)
 
def DMax (self, range)
 
def DMin (self, range)
 
def DSum (self, range)
 
def ExportRangeToFile (self, range, filename, imagetype='pdf', overwrite=False)
 
def Forms (self, sheetname, form='')
 
def GetColumnName (self, columnnumber)
 
def GetFormula (self, range)
 
def GetValue (self, range)
 
def ImportFromCSVFile (self, filename, destinationcell, filteroptions=ScriptForge.cstSymEmpty)
 
def ImportFromDatabase (self, filename='', registrationname='', destinationcell='', sqlcommand='', directsql=False)
 
def InsertSheet (self, sheetname, beforesheet=32768)
 
def MoveRange (self, source, destination)
 
def MoveSheet (self, sheetname, beforesheet=32768)
 
def Offset (self, range, rows=0, columns=0, height=ScriptForge.cstSymEmpty, width=ScriptForge.cstSymEmpty)
 
def OpenRangeSelector (self, title='', selection='~', singlecell=False, closeafterselect=True)
 
def Printf (self, inputstr, range, tokencharacter='%')
 
def PrintOut (self, sheetname='~', pages='', copies=1)
 
def RemoveDuplicates (self, range, columns=1, header=False, casesensitive=False, mode='COMPACT')
 
def RemoveSheet (self, sheetname)
 
def RenameSheet (self, sheetname, newname)
 
def SetArray (self, targetcell, value)
 
def SetCellStyle (self, targetrange, style, filterformula='', filterscope='')
 
def SetFormula (self, targetrange, formula)
 
def SetValue (self, targetrange, value)
 
def ShiftDown (self, range, wholerow=False, rows=0)
 
def ShiftLeft (self, range, wholecolumn=False, columns=0)
 
def ShiftRight (self, range, wholecolumn=False, columns=0)
 
def ShiftUp (self, range, wholerow=False, rows=0)
 
def SortRange (self, range, sortkeys, sortorder='ASC', destinationcell=ScriptForge.cstSymEmpty, containsheader=False, casesensitive=False, sortcolumns=False)
 
- Public Member Functions inherited from scriptforge.SFDocuments.SF_Document
def ReviewServiceArgs (cls, windowname='')
 
def Activate (self)
 
def CloseDocument (self, saveask=True)
 
def CreateMenu (self, menuheader, before='', submenuchar='>')
 
def Echo (self, echoon=True, hourglass=False)
 
def ExportAsPDF (self, filename, overwrite=False, pages='', password='', watermark='')
 
def PrintOut (self, pages='', copies=1)
 
def RemoveMenu (self, menuheader)
 
def RunCommand (self, command, *args, **kwargs)
 
def Save (self)
 
def SaveAs (self, filename, overwrite=False, password='', filtername='', filteroptions='')
 
def SaveCopyAs (self, filename, overwrite=False, password='', filtername='', filteroptions='')
 
def SetPrinter (self, printer='', orientation='', paperformat='')
 
def Toolbars (self, toolbarname='')
 
- Public Member Functions inherited from scriptforge.SFServices
def __init__ (self, reference=-1, objtype=None, classmodule=0, name='')
 
def __getattr__ (self, name)
 
def __setattr__ (self, name, value)
 
def __repr__ (self)
 
def Dispose (self)
 
def ExecMethod (self, flags=0, methodname='', *args)
 
def GetProperty (self, propertyname, arg=None)
 
def Properties (self)
 
def basicmethods (self)
 
def basicproperties (self)
 
def SetProperty (self, propertyname, value)
 

Static Public Attributes

string serviceimplementation = 'basic'
 
string servicename = 'SFDocuments.Calc'
 
tuple servicesynonyms = ('calc', 'sfdocuments.calc')
 
 serviceproperties
 
bool forceGetProperty = True
 
- Static Public Attributes inherited from scriptforge.SFDocuments.SF_Document
string serviceimplementation = 'basic'
 
string servicename = 'SFDocuments.Document'
 
tuple servicesynonyms = ('document', 'sfdocuments.document')
 
 serviceproperties
 
bool forceGetProperty = True
 
- Static Public Attributes inherited from scriptforge.SFServices
 vbGet
 
 vbLet
 
 vbMethod
 
 vbSet
 
int flgPost = 32
 
int flgDateArg = 64
 
int flgDateRet = 128
 
int flgArrayArg = 512
 
int flgArrayRet = 1024
 
int flgUno = 256
 
int flgObject = 2048
 
int flgHardCode = 4096
 
 moduleClass
 
 moduleStandard
 
bool forceGetProperty = False
 
dictionary propertysynonyms = {}
 
tuple internal_attributes
 
 SIMPLEEXEC = ScriptForge.InvokeSimpleScript
 
 EXEC = ScriptForge.InvokeBasicService
 

Additional Inherited Members

- Public Attributes inherited from scriptforge.SFServices
 objectreference
 
 objecttype
 
 classmodule
 
 name
 
 internal
 
 localProperties
 
 serviceimplementation
 

Detailed Description

    The SF_Calc module is focused on :
        - management (copy, insert, move, ...) of sheets within a Calc document
        - exchange of data between Basic data structures and Calc ranges of values

Definition at line 2235 of file scriptforge.py.

Member Function Documentation

◆ A1Style()

def scriptforge.SFDocuments.SF_Calc.A1Style (   self,
  row1,
  column1,
  row2 = 0,
  column2 = 0,
  sheetname = '~' 
)

◆ Activate()

def scriptforge.SFDocuments.SF_Calc.Activate (   self,
  sheetname = '' 
)

◆ Charts()

def scriptforge.SFDocuments.SF_Calc.Charts (   self,
  sheetname,
  chartname = '' 
)

◆ ClearAll()

def scriptforge.SFDocuments.SF_Calc.ClearAll (   self,
  range,
  filterformula = '',
  filterscope = '' 
)

◆ ClearFormats()

def scriptforge.SFDocuments.SF_Calc.ClearFormats (   self,
  range,
  filterformula = '',
  filterscope = '' 
)

◆ ClearValues()

def scriptforge.SFDocuments.SF_Calc.ClearValues (   self,
  range,
  filterformula = '',
  filterscope = '' 
)

◆ CompactLeft()

def scriptforge.SFDocuments.SF_Calc.CompactLeft (   self,
  range,
  wholecolumn = False,
  filterformula = '' 
)

◆ CompactUp()

def scriptforge.SFDocuments.SF_Calc.CompactUp (   self,
  range,
  wholerow = False,
  filterformula = '' 
)

◆ CopySheet()

def scriptforge.SFDocuments.SF_Calc.CopySheet (   self,
  sheetname,
  newname,
  beforesheet = 32768 
)

◆ CopySheetFromFile()

def scriptforge.SFDocuments.SF_Calc.CopySheetFromFile (   self,
  filename,
  sheetname,
  newname,
  beforesheet = 32768 
)

◆ CopyToCell()

def scriptforge.SFDocuments.SF_Calc.CopyToCell (   self,
  sourcerange,
  destinationcell 
)

◆ CopyToRange()

def scriptforge.SFDocuments.SF_Calc.CopyToRange (   self,
  sourcerange,
  destinationrange 
)

◆ CreateChart()

def scriptforge.SFDocuments.SF_Calc.CreateChart (   self,
  chartname,
  sheetname,
  range,
  columnheader = False,
  rowheader = False 
)

◆ CreatePivotTable()

def scriptforge.SFDocuments.SF_Calc.CreatePivotTable (   self,
  pivottablename,
  sourcerange,
  targetcell,
  datafields = ScriptForge.cstSymEmpty,
  rowfields = ScriptForge.cstSymEmpty,
  columnfields = ScriptForge.cstSymEmpty,
  filterbutton = True,
  rowtotals = True,
  columntotals = True 
)

◆ DAvg()

def scriptforge.SFDocuments.SF_Calc.DAvg (   self,
  range 
)

◆ DCount()

def scriptforge.SFDocuments.SF_Calc.DCount (   self,
  range 
)

◆ DMax()

def scriptforge.SFDocuments.SF_Calc.DMax (   self,
  range 
)

◆ DMin()

def scriptforge.SFDocuments.SF_Calc.DMin (   self,
  range 
)

◆ DSum()

def scriptforge.SFDocuments.SF_Calc.DSum (   self,
  range 
)

◆ ExportRangeToFile()

def scriptforge.SFDocuments.SF_Calc.ExportRangeToFile (   self,
  range,
  filename,
  imagetype = 'pdf',
  overwrite = False 
)

◆ FirstCell()

def scriptforge.SFDocuments.SF_Calc.FirstCell (   self,
  rangename 
)

◆ FirstColumn()

def scriptforge.SFDocuments.SF_Calc.FirstColumn (   self,
  rangename 
)

◆ FirstRow()

def scriptforge.SFDocuments.SF_Calc.FirstRow (   self,
  rangename 
)

◆ Forms()

def scriptforge.SFDocuments.SF_Calc.Forms (   self,
  sheetname,
  form = '' 
)

◆ GetColumnName()

def scriptforge.SFDocuments.SF_Calc.GetColumnName (   self,
  columnnumber 
)

◆ GetFormula()

def scriptforge.SFDocuments.SF_Calc.GetFormula (   self,
  range 
)

◆ GetValue()

def scriptforge.SFDocuments.SF_Calc.GetValue (   self,
  range 
)

◆ Height()

def scriptforge.SFDocuments.SF_Calc.Height (   self,
  rangename 
)

◆ ImportFromCSVFile()

def scriptforge.SFDocuments.SF_Calc.ImportFromCSVFile (   self,
  filename,
  destinationcell,
  filteroptions = ScriptForge.cstSymEmpty 
)

◆ ImportFromDatabase()

def scriptforge.SFDocuments.SF_Calc.ImportFromDatabase (   self,
  filename = '',
  registrationname = '',
  destinationcell = '',
  sqlcommand = '',
  directsql = False 
)

◆ InsertSheet()

def scriptforge.SFDocuments.SF_Calc.InsertSheet (   self,
  sheetname,
  beforesheet = 32768 
)

◆ LastCell()

def scriptforge.SFDocuments.SF_Calc.LastCell (   self,
  rangename 
)

◆ LastColumn()

def scriptforge.SFDocuments.SF_Calc.LastColumn (   self,
  rangename 
)

◆ LastRow()

def scriptforge.SFDocuments.SF_Calc.LastRow (   self,
  rangename 
)

◆ MoveRange()

def scriptforge.SFDocuments.SF_Calc.MoveRange (   self,
  source,
  destination 
)

◆ MoveSheet()

def scriptforge.SFDocuments.SF_Calc.MoveSheet (   self,
  sheetname,
  beforesheet = 32768 
)

◆ Offset()

def scriptforge.SFDocuments.SF_Calc.Offset (   self,
  range,
  rows = 0,
  columns = 0,
  height = ScriptForge.cstSymEmpty,
  width = ScriptForge.cstSymEmpty 
)

◆ OpenRangeSelector()

def scriptforge.SFDocuments.SF_Calc.OpenRangeSelector (   self,
  title = '',
  selection = '~',
  singlecell = False,
  closeafterselect = True 
)

◆ Printf()

def scriptforge.SFDocuments.SF_Calc.Printf (   self,
  inputstr,
  range,
  tokencharacter = '%' 
)

◆ PrintOut()

def scriptforge.SFDocuments.SF_Calc.PrintOut (   self,
  sheetname = '~',
  pages = '',
  copies = 1 
)

◆ Range()

def scriptforge.SFDocuments.SF_Calc.Range (   self,
  rangename 
)

◆ Region()

def scriptforge.SFDocuments.SF_Calc.Region (   self,
  rangename 
)

◆ RemoveDuplicates()

def scriptforge.SFDocuments.SF_Calc.RemoveDuplicates (   self,
  range,
  columns = 1,
  header = False,
  casesensitive = False,
  mode = 'COMPACT' 
)

◆ RemoveSheet()

def scriptforge.SFDocuments.SF_Calc.RemoveSheet (   self,
  sheetname 
)

◆ RenameSheet()

def scriptforge.SFDocuments.SF_Calc.RenameSheet (   self,
  sheetname,
  newname 
)

◆ ReviewServiceArgs()

def scriptforge.SFDocuments.SF_Calc.ReviewServiceArgs (   cls,
  windowname = '' 
)
    Transform positional and keyword arguments into positional only

Reimplemented from scriptforge.SFDocuments.SF_Document.

Definition at line 2254 of file scriptforge.py.

◆ SetArray()

def scriptforge.SFDocuments.SF_Calc.SetArray (   self,
  targetcell,
  value 
)

◆ SetCellStyle()

def scriptforge.SFDocuments.SF_Calc.SetCellStyle (   self,
  targetrange,
  style,
  filterformula = '',
  filterscope = '' 
)

◆ SetFormula()

def scriptforge.SFDocuments.SF_Calc.SetFormula (   self,
  targetrange,
  formula 
)

◆ SetValue()

def scriptforge.SFDocuments.SF_Calc.SetValue (   self,
  targetrange,
  value 
)

◆ Sheet()

def scriptforge.SFDocuments.SF_Calc.Sheet (   self,
  sheetname 
)

◆ SheetName()

def scriptforge.SFDocuments.SF_Calc.SheetName (   self,
  rangename 
)

◆ ShiftDown()

def scriptforge.SFDocuments.SF_Calc.ShiftDown (   self,
  range,
  wholerow = False,
  rows = 0 
)

◆ ShiftLeft()

def scriptforge.SFDocuments.SF_Calc.ShiftLeft (   self,
  range,
  wholecolumn = False,
  columns = 0 
)

◆ ShiftRight()

def scriptforge.SFDocuments.SF_Calc.ShiftRight (   self,
  range,
  wholecolumn = False,
  columns = 0 
)

◆ ShiftUp()

def scriptforge.SFDocuments.SF_Calc.ShiftUp (   self,
  range,
  wholerow = False,
  rows = 0 
)

◆ SortRange()

def scriptforge.SFDocuments.SF_Calc.SortRange (   self,
  range,
  sortkeys,
  sortorder = 'ASC',
  destinationcell = ScriptForge.cstSymEmpty,
  containsheader = False,
  casesensitive = False,
  sortcolumns = False 
)

◆ Width()

def scriptforge.SFDocuments.SF_Calc.Width (   self,
  rangename 
)

◆ XCellRange()

def scriptforge.SFDocuments.SF_Calc.XCellRange (   self,
  rangename 
)

◆ XSheetCellCursor()

def scriptforge.SFDocuments.SF_Calc.XSheetCellCursor (   self,
  rangename 
)

◆ XSpreadsheet()

def scriptforge.SFDocuments.SF_Calc.XSpreadsheet (   self,
  sheetname 
)

Member Data Documentation

◆ forceGetProperty

bool scriptforge.SFDocuments.SF_Calc.forceGetProperty = True
static

Definition at line 2251 of file scriptforge.py.

◆ serviceimplementation

string scriptforge.SFDocuments.SF_Calc.serviceimplementation = 'basic'
static

◆ servicename

string scriptforge.SFDocuments.SF_Calc.servicename = 'SFDocuments.Calc'
static

◆ serviceproperties

scriptforge.SFDocuments.SF_Calc.serviceproperties
static
Initial value:
= dict(CurrentSelection = True, Sheets = False,
Description = True, DocumentType = False, ExportFilters = False, FileSystem = False,
ImportFilters = False, IsBase = False, IsCalc = False, IsDraw = False,
IsFormDocument = False, IsImpress = False, IsMath = False, IsWriter = False,
Keywords = True, Readonly = False, Subject = True, Title = True, XComponent = False)

Definition at line 2245 of file scriptforge.py.

Referenced by scriptforge.SFServices.__setattr__(), and scriptforge.SFServices.Properties().

◆ servicesynonyms

tuple scriptforge.SFDocuments.SF_Calc.servicesynonyms = ('calc', 'sfdocuments.calc')
static

Definition at line 2244 of file scriptforge.py.


The documentation for this class was generated from the following file: