scriptforge.SFDocuments.SF_Document Class Reference

Inheritance diagram for scriptforge.SFDocuments.SF_Document:

Collaboration diagram for scriptforge.SFDocuments.SF_Document:

Public Member Functions
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.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 methods and properties are generic for all types of documents: they are combined in the
    current SF_Document class
        - saving, closing documents
        - accessing their standard or custom properties
    Specific properties and methods are implemented in the concerned subclass(es) SF_Calc, SF_Base, ...

Definition at line 2108 of file scriptforge.py.

Member Function Documentation

Activate()

def scriptforge.SFDocuments.SF_Document.Activate

(

self

)

Reimplemented in scriptforge.SFDocuments.SF_Calc.

Definition at line 2134 of file scriptforge.py.

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

CloseDocument()

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

Reimplemented in scriptforge.SFDocuments.SF_FormDocument, and scriptforge.SFDocuments.SF_Base.

Definition at line 2137 of file scriptforge.py.

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

CreateMenu()

def scriptforge.SFDocuments.SF_Document.CreateMenu	(		self,
			menuheader,
			before = '',
			submenuchar = '>'
	)

Definition at line 2140 of file scriptforge.py.

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

Echo()

def scriptforge.SFDocuments.SF_Document.Echo	(		self,
			echoon = True,
			hourglass = False
	)

Definition at line 2143 of file scriptforge.py.

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

ExportAsPDF()

def scriptforge.SFDocuments.SF_Document.ExportAsPDF	(		self,
			filename,
			overwrite = False,
			pages = '',
			password = '',
			watermark = ''
	)

Definition at line 2146 of file scriptforge.py.

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

PrintOut()

def scriptforge.SFDocuments.SF_Document.PrintOut	(		self,
			pages = '',
			copies = 1
	)

Reimplemented in scriptforge.SFDocuments.SF_Base, scriptforge.SFDocuments.SF_FormDocument, scriptforge.SFDocuments.SF_Writer, and scriptforge.SFDocuments.SF_Calc.

Definition at line 2149 of file scriptforge.py.

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

RemoveMenu()

def scriptforge.SFDocuments.SF_Document.RemoveMenu	(		self,
			menuheader
	)

Definition at line 2152 of file scriptforge.py.

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

ReviewServiceArgs()

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

    Transform positional and keyword arguments into positional only

Reimplemented in scriptforge.SFDocuments.SF_Base, scriptforge.SFDocuments.SF_Calc, scriptforge.SFDocuments.SF_FormDocument, and scriptforge.SFDocuments.SF_Writer.

Definition at line 2128 of file scriptforge.py.

RunCommand()

def scriptforge.SFDocuments.SF_Document.RunCommand	(		self,
			command,
		*	args,
		**	kwargs
	)

Definition at line 2155 of file scriptforge.py.

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

Save()

def scriptforge.SFDocuments.SF_Document.Save

(

self

)

Definition at line 2159 of file scriptforge.py.

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

SaveAs()

def scriptforge.SFDocuments.SF_Document.SaveAs	(		self,
			filename,
			overwrite = False,
			password = '',
			filtername = '',
			filteroptions = ''
	)

Definition at line 2162 of file scriptforge.py.

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

SaveCopyAs()

def scriptforge.SFDocuments.SF_Document.SaveCopyAs	(		self,
			filename,
			overwrite = False,
			password = '',
			filtername = '',
			filteroptions = ''
	)

Definition at line 2165 of file scriptforge.py.

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

SetPrinter()

def scriptforge.SFDocuments.SF_Document.SetPrinter	(		self,
			printer = '',
			orientation = '',
			paperformat = ''
	)

Reimplemented in scriptforge.SFDocuments.SF_Base.

Definition at line 2169 of file scriptforge.py.

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

Toolbars()

def scriptforge.SFDocuments.SF_Document.Toolbars	(		self,
			toolbarname = ''
	)

Definition at line 2172 of file scriptforge.py.

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

Member Data Documentation

forceGetProperty

bool scriptforge.SFDocuments.SF_Document.forceGetProperty = True

static

Definition at line 2125 of file scriptforge.py.

serviceimplementation

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

static

Definition at line 2117 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_Document.servicename = 'SFDocuments.Document'

static

Definition at line 2118 of file scriptforge.py.

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

serviceproperties

scriptforge.SFDocuments.SF_Document.serviceproperties

static

Initial value:

=  dict(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 2120 of file scriptforge.py.

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

servicesynonyms

tuple scriptforge.SFDocuments.SF_Document.servicesynonyms = ('document', 'sfdocuments.document')

static

Definition at line 2119 of file scriptforge.py.

---

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

• scriptforge.py