Field Class

Represents legacy field with same functionality as Field of C1Report.

Inheritance

object

ReportObject

VisualReportObject

FieldBase

Field

Implements

IScriptContextProvider

ICloneable

INotify

Namespace: C1.Report

Assembly: C1.Report.dll

Syntax

public class Field : FieldBase, IScriptContextProvider, ICloneable, INotify

Public Class Field
    Inherits FieldBase
    Implements IScriptContextProvider, ICloneable, INotify

Constructors

Name	Description
Field()	Initializes a new instance of the Field class.

Properties

Name	Description
Align	Gets or sets the text alignment within the field.
BarCode	Gets or sets a value indicating whether the field should render as barcode.
BarcodeOptions	Gets the BarcodeOptions object which allows to define various barcode-related options.
BorderColor	Gets or sets the field's border color.
BorderStyle	Gets or sets the field's border style.
Calculated	Specifies whether the Text property should be interpreted as a literal value or as a calculated expression.
CanGrow	Specifies whether the field height should be automatically increased to fit the field's contents.
CanShrink	Specifies whether the field height should be automatically reduced to fit the field's contents.
CheckBox	Specifies whether the field should be displayed as a checkbox.
Font	Gets or sets the field's font.
ForeColor	Gets or sets the field's foreground color.
Format	Gets or sets a string used to format the field value.
HideDuplicates	Specifies whether duplicate values in consecutive records should be suppressed.
LineSpacing	Gets or sets the line spacing between text lines in the field, in percent. The default is 100 which corresponds to normal line spacing. Note that this property is ignored if RTF is true.
LineWidth	Gets or sets the width of the field's border or line.
Location	Gets or sets the field's location within the section, in twips.
ParentReport	Gets the FlexReport containing this field.
Picture	Gets or sets a picture to display on the field.
PictureAlign	Gets or sets how field pictures should be the aligned.
PictureScale	Gets or sets how images should be the scaled to fit within the field area.
RTF	Gets or sets a value indicating whether strings enclosed in curly brackets should render as RTF.
RunningSum	Specifies whether to show a running sum for the field.
Shape	Gets or sets an instance of the ShapeBase-derived class specifying properties of the geometric shape drawn by this field (if ShapeType is not None).
ShapeType	Gets or sets the type of geometric shape drawn by the current field. The default is None.
Size	Gets or sets the field's size, in twips.
Subreport	Gets or sets a reference to another report to be rendered within the field (a subreport).
SubreportHasData	Returns whether a subreport has data and suppresses rendering if it doesn't.
Text	Gets or sets the field's text.
TextAngle	Gets or sets the angle of text rotation within the field (including barcodes).
Value	Gets or sets the field's calculated value.
WordWrap	Gets or sets a value indicating whether automatic word wrapping is on.
WritingMode	Gets or sets the text writing mode: horizontal (default), vertical with left to right flow etc.

Methods

Name	Description
AfterRender()	Called where report rendering finish. Can be used to finalize object after rendering.
AssignFrom(ReportObject, bool)	Copies properties from another object into this object.
BeforeRender()	Called where report rendering starts. Can be used to initialize object before rendering.
BuildRtfBrick(SubSectionBrick, string)
GetContentAutoHeight(double)	Override this method to calculate the height of object on basis of its content, this method is called when field can grow or shrink vertically.
GetContentAutoSize(out double, out double)	Override this method to calculate sizes of object on basis of its content, this method is called when field can grow or shrink vertically and horizontally.
GetContentAutoWidth(double)	Override this method to calculate the width of object on basis of its content, this method is called when field can grow or shrink horizontally.
GetPropsTable()
GetRenderContent(ref string, ref IImage, ref bool, bool)	Selects the text or image that will be rendered by the field.
GetRtfHeight(string, double)	Get RTF field height if it's supported.
Import(XmlNodeWrapperBase)	Imports node from legacy xml report definition;
InternalBuildBrick(SubSectionBrick)	This method should be overriden in descendant classes like Field, BarCodeField, ChartField and so on.
InternalRefreshBrick(FieldBrickBase)
Load(XmlNodeList)	Override in derived classes to provide advanced persistence mechanism.
PrecalculateValues()	Called by rendering engine to precalculate field's value in the footer sections: report footer, group footers.
ReadCustomProperties(C1ReaderBase)
RefreshRtfBrick(FieldBrickBase)
ResetFont()	For internal use.
ResetState()	Called when FlexReport starts calculation of the section containing this FieldBase. Resets internal state of the field.
ResetStyle()
Save(XmlWriter)	Override in derived classes to provide advanced persistence mechanism.
WriteCustomProperties(C1WriterBase)