:: com :: sun :: star :: document ::
|
service OfficeDocument |
- Description
- abstract service which specifies a storable and printable document
All major document-like components should support this service
instead of simple components which supports a ::com::sun::star::frame::Controller
or pure ::com::sun::star::awt::XWindow only.
- See also
- ::com::sun::star::frame::Controller
|
Properties' Summary |
boolean
AutomaticControlFocus |
[ OPTIONAL ]
controls the focus behaviour of the form controls in the document
|
boolean
ApplyFormDesignMode |
[ OPTIONAL ]
controls the initial (on-load) behavior of the form controls in the document
|
[ readonly ] string
RuntimeUID |
[ OPTIONAL ]
contains a unique id for the document
|
Exported Interfaces - Details |
::com::sun::star::frame::XModel
- Description
- represents a component which is created from an URL and arguments
It is a representation of a resource in the sense that it was
created/loaded from the resource. The arguments are passed to the loader
to modify its behavior.
|
|
::com::sun::star::util::XModifiable
- Description
- a storable document should provide information about his modify state
With this interface it's possible too, to reset the modify state.
That can be neccessary to prevent code against problem during closing
of the document without saving any changes.
|
|
::com::sun::star::frame::XStorable
- Description
- offers a simple way to store a component to an URL
This interface supports functionality
- to make a copy of current component by saving it to another location
- to commit made changes
- to convert it by saving it by using suitable filter name.
|
|
::com::sun::star::view::XPrintable
- Description
- offers a way to print a component
It's possible to specify wich printer should be used and of course
print the document on it.
|
|
XEventBroadcaster
- Usage Restrictions
- deprecated
- optional
- Description
- is an old and deprecated version of the XDocumentEventBroadcaster interface
|
|
XDocumentEventBroadcaster
- Usage Restrictions
- optional
- Description
- makes it possible to register listeners which are called whenever
a document event occurs
|
|
XEventsSupplier
- Usage Restrictions
- optional
- Description
- access to bound event handlers
|
|
XDocumentInfoSupplier
|
XViewDataSupplier
- Usage Restrictions
- optional
- Description
- access to some properties describing all open views to a document
|
|
::com::sun::star::view::XPrintJobBroadcaster
- Usage Restrictions
- optional
- Description
- allows for getting information about a print job
- Since
- OOo 1.1.2
|
|
XEmbeddedScripts
- Usage Restrictions
- optional
- Description
- is supported when the document can contain scripts and dialogs
- Since
- OOo 2.4
|
|
XDocumentPropertiesSupplier
|
XUndoManagerSupplier
- Usage Restrictions
- optional
- Description
- provides access to the document's undo manager.
|
|
Properties' Details |
AutomaticControlFocus
boolean AutomaticControlFocus;
- Usage Restrictions
- optional
- Description
- controls the focus behaviour of the form controls in the document
If this flag is set to true, any view belonging to the document
should focus the first control in the document. With this, you may
control if your document works primarily as a form document.
|
|
ApplyFormDesignMode
boolean ApplyFormDesignMode;
- Usage Restrictions
- optional
- Description
- controls the initial (on-load) behavior of the form controls in the document
If set to true, upon loading the document, the form controls will be in design mode.
If set to false, they will be alive, i.e. operational.
With this, you may control if your document works primarily as a form document.
|
|
RuntimeUID
[ readonly ] string RuntimeUID;
- Usage Restrictions
- optional
- Description
- contains a unique id for the document
Once calculated, the id must not change until the document has been
closed. Upon closing it will not be made persistent. Thus, the document
may get a different id every time it gets loaded.
|
|
Top of Page
Copyright © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.