Version

UltraPrintDocument Class Members

The following tables list the members exposed by UltraPrintDocument.

Public Constructors
 NameDescription
Public ConstructorUltraPrintDocument ConstructorOverloaded.   
Public Fields
 NameDescription
Public Fieldstatic (Shared in Visual Basic)DatePrintedTokenReturns a string token which can be used in the page header or footer to represent the current date.  
Public Fieldstatic (Shared in Visual Basic)PageNumberTokenReturns a string token which can be used in the page header or footer to represent the current page number.  
Public Fieldstatic (Shared in Visual Basic)TimePrintedTokenReturns a string token which can be used in the page header or footer to represent the current time.  
Public Fieldstatic (Shared in Visual Basic)TotalPagesTokenReturns a string token which can be used in the page header or footer to represent the total number of pages.  
Public Fieldstatic (Shared in Visual Basic)UserNameTokenReturns a string token which can be used in the page header or footer to represent the current user's name.  
Public Properties
 NameDescription
Public PropertyAppearanceReturns or sets the appearance used to render the pages printed by the document.  
Public PropertyContainer (Inherited from System.ComponentModel.Component)
Public PropertyDefaultPageSettingsGets or sets page settings that are used as defaults for all pages to be printed. (Inherited from System.Drawing.Printing.PrintDocument)
Public PropertyDocumentNameGets or sets the document name to display (for example, in a print status dialog box or printer queue) while printing the document. (Inherited from System.Drawing.Printing.PrintDocument)
Public PropertyFooterReturns an object used to define the appearance of the page footer.  
Public PropertyHasAppearanceReturns a Boolean value that indicates whether an Infragistics.Win.AppearanceBase object has been created.  
Public PropertyHeaderReturns an object used to define the appearance of the page header.  
Public PropertyIsPrintingIndicates if we are in the process of a print operation.  
Public PropertyOriginAtMarginsGets or sets a value indicating whether the position of a graphics object associated with a page is located just inside the user-specified margins or at the top-left corner of the printable area of the page. (Inherited from System.Drawing.Printing.PrintDocument)
Public PropertyPageReturns an object used to define the appearance of the page.  
Public PropertyPageBodyReturns an object used to define the appearance of the body of the page.  
Public PropertyPageNumberReturns the current page number.  
Public PropertyPrintColorStyleReturns or sets how colors and images are rendered.  
Public PropertyPrintControllerGets or sets the print controller that guides the printing process. (Inherited from System.Drawing.Printing.PrintDocument)
Public PropertyPrinterSettingsGets or sets the printer that prints the document. (Inherited from System.Drawing.Printing.PrintDocument)
Public PropertySaveSettingsIndicates whether this component should automatically save its user configuration settings.  
Public PropertySaveSettingsFormatGets or sets the format in which the user customizations settings will be saved and loaded  
Public PropertySettingsKeyA unique string that distinguishes this UltraPrintDocument form others in the solution it is being used in. This is needed to store user configuration settings.  
Public PropertySite (Inherited from System.ComponentModel.Component)
Protected Properties
 NameDescription
Protected PropertyCanRaiseEvents (Inherited from System.ComponentModel.Component)
Protected PropertyDesignMode (Inherited from System.ComponentModel.Component)
Protected PropertyEvents (Inherited from System.ComponentModel.Component)
Protected PropertySubObjectPropChangeHandlerHandler for a Infragistics.Shared.SubObjectBase.SubObjectPropChangedSubObjectPropChange event  
Public Methods
 NameDescription
Public MethodCalculateAvailablePageSizeCalculates the inner bounds available for the page body.  
Public MethodCreateObjRefCreates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from System.MarshalByRefObject)
Public MethodDisposeOverloaded. Overridden. Invoked when the component must release the resources it is using.  
Public MethodGetLifetimeServiceRetrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
Public MethodInitializeLifetimeServiceObtains a lifetime service object to control the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
Public MethodLoadComponentSettingsLoads the user configuration settings for this component.  
Public MethodLoadFromBinaryOverloaded. Loads saved layout information from a stream containing the binary layout.  
Public MethodLoadFromXmlOverloaded. Loads saved layout information from a stream containing the xml/soap layout.  
Public MethodPrintStarts the document's printing process. (Inherited from System.Drawing.Printing.PrintDocument)
Public MethodResetOverloaded. Resets the properties of the component to their default values.  
Public MethodResetAppearanceResets the Appearance property to its default value.  
Public MethodResetComponentSettingsResets the user configuration settings for this component.  
Public MethodResetFooterResets the properties of the Footer to their default values.  
Public MethodResetHeaderResets the properties of the Header to their default values.  
Public MethodResetPageResets the properties of the Page to their default values.  
Public MethodResetPageBodyResets the properties of the PageBody to their default values.  
Public MethodSaveAsBinaryOverloaded. Saves property information to a file in binary format.  
Public MethodSaveAsXmlOverloaded. Saves property information to a file in xml/soap format.  
Public MethodSaveComponentSettingsSaves the user configuration settings for this component.  
Public MethodToStringProvides information about the print document, in string form. (Inherited from System.Drawing.Printing.PrintDocument)
Protected Methods
 NameDescription
Protected MethodCalculatePageBodyAreaCalculates the inner bounds available for the page body.  
Protected MethodDeserializePropertyInvoked during runtime deserialization when deserializing from a stream using the LoadFromXml(Stream) and LoadFromBinary(Stream) methods.  
Protected MethodFinalize (Inherited from System.ComponentModel.Component)
Protected MethodGetObjectDataSerializes the properties and subobjects of the print document into the specified Infragistics.Shared.Serialization.ObjectStreamer  
Protected MethodGetService (Inherited from System.ComponentModel.Component)
Protected MethodMemberwiseCloneOverloaded. Creates a shallow copy of the current System.MarshalByRefObject object. (Inherited from System.MarshalByRefObject)
Protected MethodNotifyDesignEnvironmentOfChange

In design mode notifies the System.ComponentModel.Design.IComponentChangeService that the component has changed so that it can mark the component dirty.

At runtime this method does nothing.

 
Protected MethodNotifyPropChangeOverloaded. Notifies any listeners when the state of an object has changed  
Protected MethodOnBeginPrintOverridden. Used to invoke the BeginPrint event when a print operation has started.  
Protected MethodOnEndPrintOverridden. Used to invoke the EndPrint event when a print operation has completed.  
Protected MethodOnPageBodyPrintedRaises the PageBodyPrinted event.  
Protected MethodOnPageBodyPrintingRaises the PageBodyPrinting event.  
Protected MethodOnPageFooterPrintedRaises the PageFooterPrinted event.  
Protected MethodOnPageFooterPrintingRaises the PageFooterPrinting event.  
Protected MethodOnPageHeaderPrintedRaises the PageHeaderPrinted event.  
Protected MethodOnPageHeaderPrintingRaises the PageHeaderPrinting event.  
Protected MethodOnPagePrintedRaises the PagePrinted event.  
Protected MethodOnPagePrintingRaises the PagePrinting event.  
Protected MethodOnPrintEndedInvoked when the print operation has ended.  
Protected MethodOnPrintPageOverridden. Used to invoke the PrintPage event when a page is to be printed.  
Protected MethodOnPrintPageBodyThis method is invoked by the OnPrintPage to allow derived classes to handle rendering of the page body. This method is not called if the PageBodyPrintingEventArgs.Handled property of the PageBodyPrinting event is set to true.  
Protected MethodOnPropertyChangedInvokes the PropertyChanged event. This event is fired to notify listeners of a property changes on the component or a subobject.  
Protected MethodOnQueryPageSettingsOverridden. Used to invoke the QueryPageSettings event to allow the PageSettings to be altered before each page is printed.  
Protected MethodOnSubObjectPropChangedInvoked when a property on a subobject has changed.  
Protected MethodShouldSerializeAppearance

Returns a Boolean value that determines whether the Appearance property is set to its default value.

 
Protected MethodShouldSerializeFooterIndicates if any of the properties of the Footer have been set.  
Protected MethodShouldSerializeHeaderIndicates if any of the properties of the Header have been set.  
Protected MethodShouldSerializePageIndicates if any of the properties of the Page have been set.  
Protected MethodShouldSerializePageBodyIndicates if any of the properties of the PageBody have been set.  
Public Events
 NameDescription
Public EventBeginPrintOccurs when the System.Drawing.Printing.PrintDocument.Print method is called and before the first page of the document prints. (Inherited from System.Drawing.Printing.PrintDocument)
Public EventDisposed (Inherited from System.ComponentModel.Component)
Public EventEndPrintOccurs when the last page of the document has printed. (Inherited from System.Drawing.Printing.PrintDocument)
Public EventPageBodyPrintedFired after the Page has been rendered  
Public EventPageBodyPrintingFired before the PageBody is rendered  
Public EventPageFooterPrintedFired after the Footer has been rendered  
Public EventPageFooterPrintingFired before the Footer is rendered  
Public EventPageHeaderPrintedFired after the Header has been rendered  
Public EventPageHeaderPrintingFired before the Header is rendered  
Public EventPagePrintedFired after the page is rendered  
Public EventPagePrintingFired before the page is rendered  
Public EventPrintPageOccurs when the output to print for the current page is needed. (Inherited from System.Drawing.Printing.PrintDocument)
Public EventPropertyChangedFired after a property has changed.  
Public EventQueryPageSettingsOccurs immediately before each System.Drawing.Printing.PrintDocument.PrintPage event. (Inherited from System.Drawing.Printing.PrintDocument)
See Also