Inheritance diagram for scriptforge.SFDocuments.SF_Base:

Collaboration diagram for scriptforge.SFDocuments.SF_Base:

Public Member Functions
def	ReviewServiceArgs (cls, windowname='')

def	CloseDocument (self, saveask=True)

def	CloseFormDocument (self, formdocument)

def	FormDocuments (self)

def	Forms (self, formdocument, form='')

def	GetDatabase (self, user='', password='')

def	IsLoaded (self, formdocument)

def	OpenFormDocument (self, formdocument, designmode=False)

def	OpenQuery (self, queryname)

def	OpenTable (self, tablename)

def	PrintOut (self, formdocument, pages='', copies=1)

def	SetPrinter (self, formdocument='', printer='', orientation='', paperformat='')

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.Base'

tuple	servicesynonyms = ('base', 'scriptforge.base')

	serviceproperties

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_Base module is provided mainly to block parent properties that are NOT applicable to Base documents
    In addition, it provides methods to identify form documents and access their internal forms
    (read more elsewhere (the "SFDocuments.Form" service) about this subject)

Definition at line 2178 of file scriptforge.py.

Member Function Documentation

◆ CloseDocument()

def scriptforge.SFDocuments.SF_Base.CloseDocument	(	self,
		saveask = `True`
	)

Reimplemented from scriptforge.SFDocuments.SF_Document.

Definition at line 2199 of file scriptforge.py.

References scriptforge.SFServices.ExecMethod(), sfx2::SfxNotebookBar.ExecMethod(), and scriptforge.SFServices.vbMethod.

◆ CloseFormDocument()

def scriptforge.SFDocuments.SF_Base.CloseFormDocument	(	self,
		formdocument
	)

Definition at line 2202 of file scriptforge.py.

References scriptforge.SFServices.ExecMethod(), sfx2::SfxNotebookBar.ExecMethod(), and scriptforge.SFServices.vbMethod.

◆ FormDocuments()

def scriptforge.SFDocuments.SF_Base.FormDocuments ( self )

Definition at line 2205 of file scriptforge.py.

References scriptforge.SFServices.ExecMethod(), sfx2::SfxNotebookBar.ExecMethod(), scriptforge.SFServices.flgArrayRet, and scriptforge.SFServices.vbMethod.

◆ Forms()

def scriptforge.SFDocuments.SF_Base.Forms	(	self,
		formdocument,
		form = `''`
	)

Definition at line 2208 of file scriptforge.py.

References scriptforge.SFServices.ExecMethod(), sfx2::SfxNotebookBar.ExecMethod(), scriptforge.SFServices.flgArrayRet, and scriptforge.SFServices.vbMethod.

◆ GetDatabase()

def scriptforge.SFDocuments.SF_Base.GetDatabase	(	self,
		user = `''`,
		password = `''`
	)

Definition at line 2211 of file scriptforge.py.

References scriptforge.SFServices.ExecMethod(), sfx2::SfxNotebookBar.ExecMethod(), and scriptforge.SFServices.vbMethod.

◆ IsLoaded()

def scriptforge.SFDocuments.SF_Base.IsLoaded	(	self,
		formdocument
	)

Definition at line 2214 of file scriptforge.py.

References scriptforge.SFServices.ExecMethod(), sfx2::SfxNotebookBar.ExecMethod(), and scriptforge.SFServices.vbMethod.

◆ OpenFormDocument()

def scriptforge.SFDocuments.SF_Base.OpenFormDocument	(	self,
		formdocument,
		designmode = `False`
	)

Definition at line 2217 of file scriptforge.py.

References scriptforge.SFServices.ExecMethod(), sfx2::SfxNotebookBar.ExecMethod(), and scriptforge.SFServices.vbMethod.

◆ OpenQuery()

def scriptforge.SFDocuments.SF_Base.OpenQuery	(	self,
		queryname
	)

Definition at line 2220 of file scriptforge.py.

References scriptforge.SFServices.ExecMethod(), sfx2::SfxNotebookBar.ExecMethod(), and scriptforge.SFServices.vbMethod.

◆ OpenTable()

def scriptforge.SFDocuments.SF_Base.OpenTable	(	self,
		tablename
	)

Definition at line 2223 of file scriptforge.py.

References scriptforge.SFServices.ExecMethod(), sfx2::SfxNotebookBar.ExecMethod(), and scriptforge.SFServices.vbMethod.

◆ PrintOut()

def scriptforge.SFDocuments.SF_Base.PrintOut	(	self,
		formdocument,
		pages = `''`,
		copies = `1`
	)

Reimplemented from scriptforge.SFDocuments.SF_Document.

Definition at line 2226 of file scriptforge.py.

References scriptforge.SFServices.ExecMethod(), sfx2::SfxNotebookBar.ExecMethod(), and scriptforge.SFServices.vbMethod.

◆ ReviewServiceArgs()

def scriptforge.SFDocuments.SF_Base.ReviewServiceArgs	(	cls,
		windowname = `''`
	)

    Transform positional and keyword arguments into positional only

Reimplemented from scriptforge.SFDocuments.SF_Document.

Definition at line 2193 of file scriptforge.py.

◆ SetPrinter()

def scriptforge.SFDocuments.SF_Base.SetPrinter	(	self,
		formdocument = `''`,
		printer = `''`,
		orientation = `''`,
		paperformat = `''`
	)

Reimplemented from scriptforge.SFDocuments.SF_Document.

Definition at line 2229 of file scriptforge.py.

References scriptforge.SFServices.ExecMethod(), sfx2::SfxNotebookBar.ExecMethod(), and scriptforge.SFServices.vbMethod.

Member Data Documentation

◆ serviceimplementation

string scriptforge.SFDocuments.SF_Base.serviceimplementation = 'basic'

static

Definition at line 2185 of file scriptforge.py.

Referenced by scriptforge.SFServices.__repr__(), scriptforge.SFServices.__setattr__(), scriptforge.SFServices.basicmethods(), scriptforge.SFServices.basicproperties(), scriptforge.SFServices.Dispose(), scriptforge.SFServices.GetProperty(), and scriptforge.SFServices.SetProperty().

◆ servicename

string scriptforge.SFDocuments.SF_Base.servicename = 'SFDocuments.Base'

static

Definition at line 2186 of file scriptforge.py.

Referenced by scriptforge.ScriptForge.__init__(), and scriptforge.SFServices.__repr__().

◆ serviceproperties

scriptforge.SFDocuments.SF_Base.serviceproperties

static

Initial value:

=  dict(DocumentType = False, FileSystem = False, IsBase = False, IsCalc = False,
                                 IsDraw = False, IsFormDocument = False, IsImpress = False, IsMath = False,
                                 IsWriter = False, XComponent = False)

Definition at line 2188 of file scriptforge.py.

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

◆ servicesynonyms

tuple scriptforge.SFDocuments.SF_Base.servicesynonyms = ('base', 'scriptforge.base')

static

Definition at line 2187 of file scriptforge.py.

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

scriptforge.py

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ CloseDocument()

◆ CloseFormDocument()

◆ FormDocuments()

◆ Forms()

◆ GetDatabase()

◆ IsLoaded()

◆ OpenFormDocument()

◆ OpenQuery()

◆ OpenTable()

◆ PrintOut()

◆ ReviewServiceArgs()

◆ SetPrinter()

Member Data Documentation

◆ serviceimplementation

◆ servicename

◆ serviceproperties

◆ servicesynonyms