C1.Report Namespace

In This Topic

Classes

	Class	Description
	AllowedValuesDefinition	Represents a collection of allowed values for a ReportParameter.
	BarCodeField	Represents barcode in the FlexReport.
	BehaviorOptions	Specifies compatibility options for a FlexReport. 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.
	CheckBoxField	Represents a checkbox field in a report.
	CheckMark	Defines the visual properties of the check mark of the CheckBoxField.
	DataAccessException	System.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 FlexReport. Provides access to data used in reports.
	DataScope	Represents a data scope in a FlexReport.
	DataSource	Represnts a data source in a FlexReport.
	DataSourceCollection	Represents a collection of DataSource objects.
	DesignStrings.C1FlexReport
	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.
	FlexReport	Generates data-based banded reports that can be rendered to printer, preview, or exported to various portable formats (including HTML, PDF and other).
	FontData	Represents platform independent Font object. Under WinForms encapsulates a C1.Util.Font object and provides get/set access to the font properties.
	FontHolder	Represents platform independent Font object. Under WinForms encapsulates a 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 FlexReport.ReportError event.
	ReportEventArgs	Provides data for FlexReport.StartPage, FlexReport.EndPage, FlexReport.StartSection, FlexReport.PrintSection events.
	ReportGetScriptObjectEventArgs	Provides data for FlexReport.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.
	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.
	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 member containing members.
	ReportObjectNamedList<TItem>	Represents the list of strong named report objects.
	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.
	StrongNamedReportObject	Represents a strong named object, this is base class for DataSource, ReportParameter.
	SubreportField	Field used to show subreports in FlexReport.
	SubSection	Represents a band within a Section. Each Section contains at least one SubSection.
	SubSectionCollection	Represents collection of the SubSection objects.
	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 FlexReport.

Interfaces

	Interface	Description
	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 FlexReport 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: System.Data.DataTable, System.Data.DataView and System.Collections.IList.
	IC1FlexReportRecordsetFilter	Interface used to provide filtering functionality for data accessed by FlexReport. This interface allows FlexReport to access data stored in a data object of a type for which it does not have built-in support. C1FlexReport has built-in support for the following data object types: System.Data.DataTable, System.Data.DataView, and System.Collections.IList.
	IReportScriptContext	Represents a local context for script evaluation and execution.

Structures

	Structure	Description
	StringParser.Params	Defines parameters for working with string: search, replace, etc.

Delegates

	Delegate	Description
	ReportErrorEventHandler	Represents the method that will handle FlexReport.ReportError event.
	ReportEventHandler	Represents the method that will handle FlexReport.StartPage, FlexReport.EndPage, FlexReport.StartSection, FlexReport.PrintSection events.
	ReportGetScriptObjectEventHandler	Represents the method that will handle FlexReport.GetScriptObject event.

Enumerations

	Enumeration	Description
	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 SubSection.AutoHeight and SubSection.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 DataSource.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 FlexReport.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.

Reference

C1.FlexReport Assembly