scriptforge.SFDocuments.SF_FormDocument Class Reference

Inheritance diagram for scriptforge.SFDocuments.SF_FormDocument:

Collaboration diagram for scriptforge.SFDocuments.SF_FormDocument:

Public Member Functions
def	ReviewServiceArgs (cls, windowname='')
def	CloseDocument (self)
def	Forms (self, form='')
def	GetDatabase (self, user='', password='')
def	PrintOut (self, pages='', copies=1, printbackground=True, printblankpages=False, printevenpages=True, printoddpages=True, printimages=True)
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.FormDocument'
tuple	servicesynonyms = ('formdocument', 'sfdocuments.formdocument')
	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 orchestration of Base form documents (aka Base Forms, but this is confusing)
    and the identification of and the access to their controls.
    Form documents are always contained in a Base document.
    They should not be confused with Writer documents containing forms,
    even if it is easy to convert the former to the latter.

Definition at line 2591 of file scriptforge.py.

Member Function Documentation

CloseDocument()

def scriptforge.SFDocuments.SF_FormDocument.CloseDocument

(

self

)

Reimplemented from scriptforge.SFDocuments.SF_Document.

Definition at line 2614 of file scriptforge.py.

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

Forms()

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

Definition at line 2617 of file scriptforge.py.

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

GetDatabase()

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

Definition at line 2620 of file scriptforge.py.

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

PrintOut()

def scriptforge.SFDocuments.SF_FormDocument.PrintOut	(		self,
			pages = '',
			copies = 1,
			printbackground = True,
			printblankpages = False,
			printevenpages = True,
			printoddpages = True,
			printimages = True
	)

Reimplemented from scriptforge.SFDocuments.SF_Document.

Definition at line 2623 of file scriptforge.py.

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

ReviewServiceArgs()

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

    Transform positional and keyword arguments into positional only

Reimplemented from scriptforge.SFDocuments.SF_Document.

Definition at line 2608 of file scriptforge.py.

Member Data Documentation

serviceimplementation

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

static

Definition at line 2600 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_FormDocument.servicename = 'SFDocuments.FormDocument'

static

Definition at line 2601 of file scriptforge.py.

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

serviceproperties

scriptforge.SFDocuments.SF_FormDocument.serviceproperties

static

Initial value:

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

Definition at line 2603 of file scriptforge.py.

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

servicesynonyms

tuple scriptforge.SFDocuments.SF_FormDocument.servicesynonyms = ('formdocument', 'sfdocuments.formdocument')

static

Definition at line 2602 of file scriptforge.py.

---

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

• scriptforge.py