[]
        
(Showing Draft Content)

C1.WPF.FlexReport

C1.WPF.FlexReport Namespace

Classes

AllowedValuesDefinition

Represents a collection of allowed values for a ReportParameter.

BarCodeField

Represents barcode in the C1FlexReport.

BehaviorOptions

Specifies compatibility options for a C1FlexReport. Properties in this class can be used to control compatibility with older versions and with C1Report.

BoundLabeledValues

Represents the dynamic list of the labeled values, the count of values is defined by the count of records in the linked DataSource, ValueExpression used to calculated actual value, LabelExpression used to calculated a label of value.

C1FlexReport

Generates data-based banded reports that can be rendered to printer, preview, or exported to various portable formats (including HTML, PDF and other).

CalculatedField

Represents a calculated data field associated with a C1FlexReport's data source. Usually values of such fields are calculated based on values of other fields in the data source.

CalculatedFieldCollection

Represents a collection of CalculatedField objects.

CheckBoxField

Represents a checkbox field in a report.

CheckMark

Defines the visual properties of the check mark of the CheckBoxField.

DataAccessException

Exception that is thrown when a data access error occurs.

DataField

Represents field in the DataSource.

DataFieldCollection

Collection of the fields in the DataSource.

DataHandler

Represents a data enumerator in a C1FlexReport. Provides access to data used in reports.

DataScope

Represents a data scope in a C1FlexReport.

DataSource

Represnts a data source in a C1FlexReport.

DataSourceCollection

Represents a collection of DataSource objects.

DbFactoryLink

The class for implementing the database factory.

ExecuteScriptAction

Executes specified script and generates the report.

Field

Represents legacy field with same functionality as Field of C1Report.

FieldBase

Abstract base class for all C1FlexReport field types.

FieldCollection

Represents the collection of the FieldBase objects.

FlexChartField

Represents a report field with a chart which is implemented using the FlexChart control.

FlexChartFieldBase

Abstract base class for report fields with FlexChart-based charts.

FontData

Represents platform independent Font object. Under WinForms encapsulates a C1.WPF.Document.Util.Font object and provides get/set access to the font properties.

FontDataCollection

Collection of the FontHolder objects.

FontHolder

Represents platform independent Font object. Under WinForms encapsulates a C1.WPF.FlexReport.FontHolder.Font object and provides get/set access to the font properties.

Group

Object used to sort and group report data.

GroupCollection

Represents a collection of Group objects.

ImageField

Represents a report field containing a data bound or static image.

Layout

The Layout object controls how the report is rendered on pages.

ParagraphField

Represents a field containing a paragraph of formatted text.

ParagraphItem

Abstract base class for objects representing fragments within a ParagraphField.

ParagraphItemCollection

Represents a collection of ParagraphItem objects.

ParagraphText

Represents run of text in the ParagraphField.

RenderReportAction

Renders the report with specified set of parameters.

ReportErrorEventArgs

Provides data for ReportError event.

ReportEventArgs

Provides data for StartPage, EndPage, StartSection, PrintSection events.

ReportGetScriptObjectEventArgs

Provides data for GetScriptObject event.

ReportHyperlink

Represents a hyperlink in a report.

ReportInfo

Class that contains report metadata.

ReportLabeledValue

Represents a value with an associated label. Both label and value can be specified as constants or as expressions.

ReportLabeledValues

Represents a collection of ReportLabeledValue object.

ReportLinkTargetBase

Describes the target of a ReportHyperlink. This is an abstract base class for the following derived classes: ReportLinkTargetBookmark, ReportLinkTargetUrl.

ReportLinkTargetBookmark

Describes a ReportLinkTargetBase pointing to a some position within a report or another report.

ReportLinkTargetScript

Describes a ReportLinkTargetBase that executes a script.

When the hyperlink is clicked in a viewer, the specified script is executed and then the report is re-generated.

The script is executed when the data source is not yet open, so fields' values are unavailable.

This script can be used to change the report parameters' values, properties of the report's fields, sections and so on.

ReportLinkTargetUrl

Describes a ReportLinkTargetBase pointing to an external document, file or URL. The hyperlink jump is performed using the ShellExecute OS shell API, so the result depends on the operating system and installed programs.

ReportNamedCollection<TItem>

Represents a C1.WPF.Document.NamedCollection<TItem> that notifies C1FlexReport about changes.

ReportObject

Represents a named object, this is base class for FieldBase, Section, SubSection and another report's objects.

ReportObjectCollection<TItem>

Represents the collection of the ReportObject objects.

ReportObjectList<TItem>

Represents the list of the ReportObject objects, in compare with ReportObjectCollection<TItem> this class addes List<T> member containing members.

ReportObjectNamedList<TItem>

Represents the list of strong named report objects.

ReportOwnedCollection<TItem>

Represents a C1.WPF.Document.OwnedCollection<TItem> that notifies C1FlexReport about changes.

ReportParameter

Represents a parameter in a C1FlexReport.

ReportParameterCollection

Represents a collection of ReportParameter objects.

ReportParameterValue

Represents a report parameter value.

ReportParameterValues

Collection of the ReportParameterValue objects.

RtfField

Represents a field containing Rich Text Format text (RTF).

ScriptEnumValue<T>

Represents an enum value that can be specified as a constant or as an expression.

ScriptObjectValue

Represents an object value that can be specified as a constant or as an expression.

ScriptStringValue

Represents a string that can be specified as a constant or as an expression.

ScriptValue<T>

The abstract base class for types such as ScriptStringValue, ScriptObjectValue and others that allow to specify a value either as a literal or as an expression.

Section

Represents a report band.

SectionCollection

Collection of the Section objects.

ShapeField

Represents a field containing a geometric shape.

SortDefinition

Defines the sorting parameters.

SortDefinitionCollection

Represents a collection of SortDefinition objects.

StrongNamedReportObject

Represents a strong named object, this is base class for DataSource, ReportParameter.

SubSection

Represents a band within a Section. Each Section contains at least one SubSection.

SubSectionCollection

Represents collection of the SubSection objects.

SubreportField

Field used to show subreports in C1FlexReport.

TextField

Represents a field containing a uniformly formatted databound or static text.

TextFieldBase

Abstract base class for ParagraphField, TextField and CheckBoxField.

VisualReportObject

Base class for all visual report objects like FieldBase, Section, SubSection. Defines common visual properties: Border, Background etc.

Watermark

Represents a watermark or an overlay in a C1FlexReport.

Interfaces

IC1FlexReportExternalRecordset

Represents an external record set residing in a separate assembly.

If an assembly contains a type supporting this interface, that assembly and type can be selected in the report designer as the data source for a report. A reference to that type and the record set initialization parameters (see Params) are then saved in the XML report definition file. When the report is loaded, the recordset object is created based on the saved info, and used as the data source for the report.

IC1FlexReportRecordset

Interface used to allow C1FlexReport to access data stored in a data object of a type for which C1FlexReport does not have built-in support.

C1FlexReport has built-in support for the following data object types: DataTable, DataView and IList.

IReportScriptContext

Represents a local context for script evaluation and execution.

Enums

AnchorEnum

Determines how the field is positioned with respect to its containing subsection when the subsection grows or shrinks as a result of the subsection's AutoHeight and AutoHeight properties.

AutoSizeBehavior

Defines options controlling how an object's size changes automatically depending on its content.

BorderStyleEnum

Specifies the Field’s border style.

CheckBoxEnum

Specifies how boolean values are translated into check boxes.

CheckMarkStyle

Gets or sets the style of a check mark.

ColumnLayoutEnum

Specifies the layout for the columns (down or across).

DataProvider

Specifies the type of the data source. Different data sources use different connection string and query command syntaxes.

FieldAlignEnum

Specifies the alignment of text within the field's rectangle.

FilterExpressionSyntax

Specifies the syntax of the Filter expression.

FontEmbedType

The type of embed of fonts into the report.

ForcePageBreakEnum

Determines whether page breaks should be inserted before or after a field, subsection or section.

GrowShrinkModeEnum

Specifies the logic for handling CanGrow/CanShrink fields.

HdrFtrEnum

Specifies where the Page Footer and Page Header sections are displayed.

KeepTogetherEnum

Specifies whether the group should be kept together on a page.

OrientationEnum

Specifies the page orientation.

ParameterPassingMode

Specifies the mode of passing parameters to the data source.

PictureAlignEnum

Specifies the alignment of images within the field's rectangle.

PictureScaleEnum

Specifies the scaling of images within the field's rectangle.

PictureShowEnum

Specifies where the background picture is displayed.

RecordSourceType

Specifies the type of the record source, such as a table, a stored procedure, or an SQL query.

RunningSumEnum

Determines whether to calculate a running sum.

SectionTypeEnum

Specifies the section type, which is equivalent to a the index of a Section object in the control's Sections collection.

SortDirection

Defines the types of sorting.

SortEnum

Specifies how groups should be sorted.

SplitBehavior

Defines the splitting behavior of a report object.

WatermarkVisibility

Specifies where watermark or overlay is displayed.

Delegates

ReportErrorEventHandler

Represents the method that will handle ReportError event.

ReportEventHandler

Represents the method that will handle StartPage, EndPage, StartSection, PrintSection events.

ReportGetScriptObjectEventHandler

Represents the method that will handle GetScriptObject event.