XtraReport Members
#Constructors
Name | Description |
---|---|
Xtra |
Initializes a new instance of the Xtra |
#Fields
Name | Description |
---|---|
Default |
Always Horizontal |
Default |
A Size object representing the default page size (850 by 1100 hundredths of an inch) used for reports. |
Default |
Represents the default paper type used in a report. |
#Properties
Name | Description |
---|---|
Back |
Gets or sets a control’s background color. Inherited from XRControl. |
Band | Provides access to the owner band, in which the current control is situated. Inherited from XRControl. |
Bands |
Gets the collection of bands contained in a report.
Inherited from Xtra |
Bookmark | Gets or sets the text shown as a root bookmark in a Document Map. |
Bookmark |
Specifies whether or not to suppress duplicated bookmarks in a final document. |
Border |
Gets or sets the control’s border color. Inherited from XRControl. |
Border |
Specifies the dash style for the control’s border. Inherited from XRControl. |
Borders | Specifies a set of borders (top, right, bottom, left) that should be visible for the control. Inherited from XRControl. |
Border |
Specifies the width of cell borders in pixels, as a floating point value. Inherited from XRControl. |
Calculated |
Provides access to a report’s collection of calculated fields. |
Can |
Overrides the XRControl. |
Can |
Gets a value indicating whether the component can raise an event. Inherited from Component. |
Component |
Retrieves a collection of components serialized along with the report, such as data sources. |
Container | Gets the IContainer that contains the Component. Inherited from Component. |
Control |
Gets the assembly-qualified name of the report. |
Cross |
Provides access to a collection of cross-band controls in the current report. |
Current |
Inherited from Xtra |
Current |
Gets the index of the current data row in a report’s Xtra |
Data |
Specifies the data adapter that should be used to populate a report’s data source.
Inherited from Xtra |
Data |
Specifies the collection, list, or table in the object assigned to the Data |
Data |
Gets or sets an object that supplies data to the report.
Inherited from Xtra |
Data |
Gets or sets an XML/XSD file, containing a schema of a report’s data source. |
Default |
Provides access to an object that defines which of the system’s default printer settings should be used when printing an Xtra |
Designer |
Provides access to the options that determine the availability of popup hints and warnings in the Report Designer. |
Design |
Gets a value that indicates whether the Component is currently in design mode. Inherited from Component. |
Display |
Gets or sets the report’s display name. If the name is not empty, it serves as the default name of the exported document and appears in the End-User Designer‘s report tab. Otherwise, the value of the report’s Name property is used as a display name. |
Draw |
Gets or sets a value indicating whether to draw the snap grid over the report surface. |
Draw |
Gets or sets a value indicating whether or not to draw a watermark at design time. |
Events protected | Gets the list of event handlers that are attached to this Component. Inherited from Component. |
Expanded | For internal use. |
Export |
Gets the settings used to specify exporting parameters when exporting a report. |
Expression |
Provides access to a control’s collection of expression bindings. Inherited from XRControl. |
Extensions | Provides access to the report’s extensions. |
Filter |
Specifies the criteria used to filter data in a report.
Inherited from Xtra |
Font | Gets or sets the control’s font. Inherited from XRControl. |
Fore |
Gets or sets the control’s foreground color. Inherited from XRControl. |
Formatting |
Provides access to a collection of formatting rules applied to this control. Inherited from XRControl. |
Formatting |
Provides access to a collection of formatting rules stored in a report. |
Has |
Gets a value indicating whether the control contains other XRControl objects. Inherited from XRControl. |
Horizontal |
When the brick dimensions do not fit into the bottom page margin, specifies whether the brick content is split across two pages or moved to a new page. |
Image |
Provides access to a collection of the report’s named images. |
Index | Gets the zero-based index of this control in its parent’s collection of controls. Inherited from XRControl. |
Is |
For internal use. Gets a value indicating whether the control has been disposed of. Inherited from XRControl. |
Is |
Checks whether the report element (control or band) is a single child of its parent. Inherited from XRControl. |
Landscape | Gets or sets a value indicating whether the page orientation is landscape. |
Localization |
Provides access to a collection of items that combine the property name, its value and a language name. |
Margins | Gets or sets the report’s page margins. |
Master |
Gets or sets the Xtra |
Name | Gets or sets a name of the control. Inherited from XRControl. |
Padding | Gets or sets the control’s padding values (measured in report units). Inherited from XRControl. |
Page |
Gets or sets the fill color of report pages. |
Page |
Gets or sets the height of the report pages (measured in report units). Available only if the XtraCustom .
|
Pages | Gets a collection of pages generated for this report. |
Page |
Gets or sets the size of the report’s pages (measured in report units). |
Page |
Gets or sets the width of the report pages measured in report units. Only in effect if XtraCustom .
|
Paper |
Gets or sets the report’s paper kind. |
Paper |
Gets or sets the name of the custom paper which is used in the printer that the document is going to be printed on. |
Parameter |
|
Parameters | Provides access to a report’s collection of parameters. |
Parent | Specifies the parent object that contains the current control. Inherited from XRControl. |
Printer |
Specifies the name of the printer to use for printing the report. |
Printing |
Returns a report’s Printing System that provides print and export settings. |
Report | Provides access to the report that contains the control. Inherited from XRControl. |
Report |
Provides access to options that define a report’s print-out.
Inherited from Xtra |
Report |
Specifies the system of measurement that is used throughout a report for expressing the values of certain properties (e. |
Request |
Specifies whether the report document creation should start only after the user submits all the report parameter values. |
Right |
Specifies the content orientation of the Xtra |
Right |
Specifies the position of controls within report bands. |
Roll |
Specifies whether the document is supposed to be printed on roll paper (in other words, as a single uninterrupted page). |
Root |
Provides access to the report to which the control belongs. Inherited from XRControl. |
Row |
Gets the total amount of data rows in a report’s Xtra |
Script |
Gets or sets the scripting language of all the scripts used in this Xtra |
Script |
Specifies the collection of file names (with full or relative paths) of the assemblies used by the scripts in a report. |
Script |
Gets or sets the string containing all script references represented by the Xtra |
Scripts |
Provides access to an object that contains Xtra |
Scripts |
Specifies the report scripts. |
Show |
Specifies whether the report preview window shows page margin lines. |
Show |
Gets or sets a value which specifies whether an error message is shown when the page margins are set outside the printable area. |
Show |
Gets or sets a value specifying whether a print status dialog is shown when a document is printed. |
Show |
Obsolete. Gets or sets a value indicating whether all property names and their values should be displayed in the user-friendly format in the Properties window and smart tags of the End-User Designer. |
Site | Gets or sets the ISite of the Component. Inherited from Component. |
Snap |
Specifies the dimensions of the report designer snap grid. |
Snap |
Specifies the number of grid cells comprising a larger snap grid unit. |
Snapping |
Specifies the mode in which report elements are snapped to each other when they are resized or being relocated. |
Source |
For internal use. |
Style |
Provides access to a collection of styles stored in a report. |
Style |
Gets or sets a path to the style sheet contained in a style sheet file. |
Tag | Bindable. Gets or sets the object that contains data about this control. Inherited from XRControl. |
Text |
Specifies the positioning of text within a control. Inherited from XRControl. |
Vertical |
Gets or sets a value indicating whether report controls outside the right page margin should be split across pages, or moved in their entirety to the next page. |
Visible | Gets or sets a value that specifies whether the report control is displayed in the document. Inherited from XRControl. |
Watermark |
Bindable. Specifies the unique identifier of a watermark to be displayed in a report. |
Watermarks | Gets the collection of watermarks. |
Xml |
Specifies the path to an XML file that should be used as the report’s data source.
Inherited from Xtra |
#Methods
Name | Description |
---|---|
All |
Returns a collection that contains all controls found within XRControl (within a report). Inherited from XRControl. |
Apply |
Applies the filter string assigned to the Xtra |
Apply |
Applies values contained in the localized report for the specified culture. |
Apply |
Applies values contained in the localized report for the specified locale. |
Begin |
For internal use. Starts the Xtra |
Begin |
Starts the Xtra |
Bring |
Brings the control to the front of the z-order. Inherited from XRControl. |
Collect |
|
Create |
Creates a band of the specified type.
Inherited from Xtra |
Create |
Creates a document from the report instance to display or print at a later time. |
Create |
Creates a document from the Xtra |
Create |
Asynchronously creates a document from an Xtra |
Create |
For internal use. Creates a report document for editing using a Silverlight Report Designer. |
Create |
Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.
Inherited from Marshal |
Create |
Creates a Printing System for the report. |
Dispose() | Releases all resources used by the Component. Inherited from Component. |
End |
For internal use. Ends the Xtra |
End |
Ends the Xtra |
Ensure |
This method is intended for internal use only. Normally, you don’t need to use it. |
Equals |
Determines whether the specified object instances are considered equal. Inherited from Object. |
Equals |
Determines whether the specified object is equal to the current object. Inherited from Object. |
Export |
Exports a report to the specified stream in CSV format. |
Export |
Exports a report to the specified file in CSV format. |
Export |
Asynchronously exports a report to the specified stream in CSV format. |
Export |
Asynchronously exports a report to the specified file in CSV format. |
Export |
Exports a report to the specified stream in DOCX format. |
Export |
Exports a report to the specified file DOCX format. |
Export |
Asynchronously exports a report to the specified stream in DOCX format. |
Export |
Asynchronously exports a report to the specified file in DOCX format. |
Export |
Exports a report to the specified stream in HTML format. |
Export |
Exports a report to the specified file in HTML format. |
Export |
Asynchronously exports a report to the specified stream in HTML format. |
Export |
Asynchronously exports a report to the specified file in HTML format. |
Export |
Exports a report to the specified stream in the specified image format. |
Export |
Exports a report to the specified stream as an image. Use options to specify an image format. |
Export |
Exports a report to the specified file in the specified image format. |
Export |
Exports a report to the specified file in Image format. |
Export |
Asynchronously exports a report to the specified stream in image format. |
Export |
Asynchronously exports a report to the specified file in image format. |
Export |
Exports a report to HTML and inserts it into a specified e-mail message. |
Export |
Exports a report to HTML and inserts it into a specified e-mail message. |
Export |
Exports a report to HTML and inserts it into a specified e-mail message. |
Export |
Asynchronously exports a report to HTML and inserts it into a specified e-mail message. |
Export |
Asynchronously exports a report to HTML and inserts it into a specified e-mail message. |
Export |
Asynchronously exports a report to HTML and inserts it into a specified e-mail message. |
Export |
Exports a report to the specified stream in MHT format. |
Export |
Exports a report to the specified file in MHT format. |
Export |
Asynchronously exports a report to the specified stream in MHT format. |
Export |
Asynchronously exports a report to the specified file in MHT format. |
Export |
Exports a report to the specified stream in PDF format. |
Export |
Exports a report to the specified file in PDF format. |
Export |
Asynchronously exports a report to the specified stream in PDF format. |
Export |
Asynchronously exports a report to the specified file in PDF format. |
Export |
Exports a report to the specified stream in RTF format. |
Export |
Exports a report to the specified file in RTF format. |
Export |
Asynchronously exports a report to the specified stream in RTF format. |
Export |
Asynchronously exports a report to the specified file in RTF format. |
Export |
Exports a report to the specified stream in text format. |
Export |
Exports a report to the specified file in text format. |
Export |
Asynchronously exports a report to the specified stream in text format. |
Export |
Asynchronously exports a report to the specified file in text format. |
Export |
Exports a report to the specified stream in CSV format. This method exports data in WYSIWYG mode. |
Export |
Exports a report to the specified file in XLS format. This method exports data in WYSIWYG mode. |
Export |
Asynchronously exports a report to the specified stream in XLS format. |
Export |
Asynchronously exports a report to the specified file in XLS format. |
Export |
Exports a report to the specified stream in XLSX format. This method exports data in WYSIWYG mode. |
Export |
Exports a report to the specified file in XLSX format. This method exports data in WYSIWYG mode. |
Export |
Asynchronously exports a report to the specified stream in XLSX format. |
Export |
Asynchronously exports a report to the specified file in XLSX format. |
Fill |
Populates a data source, which is assigned to a report’s Xtra |
Fill |
Inherited from Xtra |
Find |
Finds the control that has the specified name in the XRControl. |
From |
Obtains the real name of a data field, based on the field’s display name.
Inherited from Xtra |
From |
Loads the report definition from the specified REPX file. |
From |
Loads the report definition data from the specified stream and creates a report object from it. The created report’s class is also specified in the REPX data format. |
From |
Loads the serialized report definition from the specified XML file. |
From |
Loads the report definition data from the specified stream and creates a report object from it. The created report’s class is also specified in the XML data format. |
Get |
Returns the current value of the specified column (field) from a collection assigned to a report’s Data Member property. If the property is not specified, the method returns the current value from a root collection of the report’s Data Source.
Inherited from Xtra |
Get |
Returns the current value (strongly typed) of the specified column (field) from a collection assigned to a report’s Data Member property. If the property is not specified, the method returns the current value from a root collection of the report’s Data Source.
Inherited from Xtra |
Get |
Returns the current data row from a collection assigned to a report’s Data Member property. If the property is not specified, the method returns the current value from a root collection of the report’s Data Source.
Inherited from Xtra |
Get |
Inherited from Xtra |
Get |
Returns the color actually used as the control’s background color. Inherited from XRControl. |
Get |
Returns the color actually used as the control’s border color. Inherited from XRControl. |
Get |
Returns the border dash style that is actually used by the control. Inherited from XRControl. |
Get |
Returns the borders settings actually used as the control’s borders settings. Inherited from XRControl. |
Get |
Returns the border width settings actually used as the control’s current settings. Inherited from XRControl. |
Get |
Returns the font actually used as the control’s font. Inherited from XRControl. |
Get |
Returns the color actually used as the control’s foreground color. Inherited from XRControl. |
Get |
Returns the padding values actually used as the control’s padding. Inherited from XRControl. |
Get |
Returns the actual visual style of a control taking into account all formatting rules and odd/even styles applied to the control. Inherited from XRControl. |
Get |
Returns the text alignment actually used as the control’s text alignment. Inherited from XRControl. |
Get |
Inherited from Xtra |
Get |
Serves as the default hash function. Inherited from Object. |
Get |
Retrieves the current lifetime service object that controls the lifetime policy for this instance.
Inherited from Marshal |
Get |
Gets the value of the specified column in the row that follows the current row in the report data source.
Inherited from Xtra |
Get |
Gets the next value (strongly typed) of the specified column in the report’s Xtra |
Get |
Returns the next data row in the report’s data source.
Inherited from Xtra |
Get |
Gets the previous value of the specified column in the report’s Xtra |
Get |
Gets the previous value (strongly typed) of the specified column in the report’s data source.
Inherited from Xtra |
Get |
Returns the previous data row in the report’s data source.
Inherited from Xtra |
Get |
Returns an object that represents a service provided by the Component or by its Container. Inherited from Component. |
Get |
Gets the Type of the current instance. Inherited from Object. |
Has |
Returns a collection of controls for which export warnings exist. |
Initialize |
Obtains a lifetime service object to control the lifetime policy for this instance.
Inherited from Marshal |
Iterate |
For internal use.
Inherited from Xtra |
Load |
Loads a report from a Stream that contains XML or Code |
Load |
Loads a report from a file that contains a report definition, based on XML or Code |
Load |
Loads a report from a Stream that contains a serialized report in XML format. |
Load |
Loads a report from a file that contains an XML-serialized report. |
Memberwise |
Creates a shallow copy of the current Object. Inherited from Object. |
Memberwise |
Creates a shallow copy of the current Marshal |
Modify |
Adds and/or removes the report’s document pages. |
Perform |
Forces the control to apply layout logic to itself and all its child controls. Inherited from XRControl. |
Print |
Sends a report to the specified printer. |
Print |
Asynchronously sends a report to the specified printer. |
Reference |
Determines whether the specified Object instances are the same instance. Inherited from Object. |
Remove |
Removes inappropriate bindings assigned to the XRControl‘s properties. Inherited from XRControl. |
Reset |
Resets the XRControl. |
Reset |
Resets the XRControl. |
Reset |
Resets the XRControl. |
Reset |
Resets the XRControl. |
Reset |
Resets the XRControl. |
Reset |
Resets the XRControl. |
Reset |
Resets the XRControl. |
Reset |
Resets the XRControl. |
Reset |
Resets the XRControl. |
Resume |
Resumes normal layout logic for the control. Inherited from XRControl. |
Save |
Saves the report document to the specified stream in the XML-based PRNX format. |
Save |
Saves the report document to the specified file in the XML-based PRNX format. |
Save |
Saves the report definition to a Stream object as a Code Document Object Model (Code |
Save |
Saves the report definition to a Stream as a Code Document Object Model (Code |
Save |
Saves the report definition to a file as a Code Document Object Model (Code |
Save |
Saves the report definition to a file as a Code Document Object Model (Code |
Save |
Save the report in XML format to the specified stream. |
Save |
Saves the report in XML format to the specified file. |
Send |
Sends the control to the back of the z-order. Inherited from XRControl. |
Stop |
Interrupts the process of document creation. |
Suspend |
Temporarily suspends the layout logic for the control. Inherited from XRControl. |
To |
The method is not implemented. Inherited from Band. |
To |
The method is not implemented. Inherited from Band. |
To |
Returns a String containing the name of the Component, if any. This method should not be overridden. Inherited from Component. |
Unit |
Obsolete. Converts report measurement units into screen coordinates. |
Validate |
Validates report scripts. |
#Events
Name | Description |
---|---|
After |
Occurs after an XRControl object is displayed in the report. Inherited from XRControl. |
Band |
Occurs when the height of any band in the collection returned by the Xtra |
Before |
Occurs before an XRControl object creates its image in a report being generated. Inherited from XRControl. |
Data |
Occurs before report generation, to specify a data source for the report.
Inherited from Xtra |
Data |
Occurs when the current row in the report’s data source has been changed.
Inherited from Xtra |
Designer |
Occurs after the End-User Designer for Win |
Disposed | Occurs when the component is disposed by a call to the Dispose() method. Inherited from Component. |
Draw |
Overrides the XRControl. |
Evaluate |
Overrides the XRControl. |
Fill |
Fires after page rendering if a gap remains between the rendered bands. |
Filter |
Occurs every time the Properties window refreshes its item list in the End-User Designer. |
Filter |
Obsolete. Occurs every time the Properties window refreshes its item list in the End-User Designer. |
Height |
Occurs when the band height is changed. Inherited from Band. |
Html |
Overrides the XRControl. |
Location |
Overrides the XRControl. |
Parameters |
Occurs before the Parameters panel is displayed in the Print Preview. |
Parameters |
Occurs when all parameter values in the Parameters UI are entered, and the Submit button is pressed. |
Parameters |
Occurs when parameter values change in the Parameters user interface. |
Parent |
Overrides the XRControl. |
Preview |
Hides the inappropriate XRControl. |
Preview |
Hides the inappropriate XRControl. |
Preview |
Hides the inappropriate XRControl. |
Preview |
Hides the inappropriate XRControl. |
Preview |
Hides the inappropriate XRControl. |
Print |
Overrides the XRControl. |
Print |
Occurs before sending every document page to a printer to indicate the current printing progress. |
Save |
Occurs when a report is saved to an REPX file and allows you to manually decide which components should be stored into a report definition file, and which aren’t. |
Size |
Overrides the XRControl. |
Text |
Overrides the XRControl. |