FieldBase Class

Abstract base class for all FlexReport field types.

Inheritance

object

ReportObject

FieldBase

Implements

IScriptContextProvider

ICloneable

Namespace: C1.Report

Assembly: C1.Report.dll

Syntax

public abstract class FieldBase : VisualReportObject, IScriptContextProvider, ICloneable

Public MustInherit Class FieldBase
    Inherits VisualReportObject
    Implements IScriptContextProvider, ICloneable

Constructors

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

Fields

Name	Description
c_flgMax
m_RenderBounds	Contains actual bounds of field, after calculating its subsection.
m_flags

Properties

Name	Description
ActualRightToLeft	Gets the actual right-to-left value that is being used. If the field's own RightToLeft is not null, that value is returned. Otherwise the ActualRightToLeft defined on the report is returned.
Anchor	Gets or sets a value determining how the field's vertical position changes relative to its containing SubSection.
AutoHeight	Gets or sets a value determining how height of object changes depending on its content.
AutoWidth	Gets or sets a value determining how width of object changes depending on its content.
Bottom	Gets the y-coordinate of the field's bottom edge in twips.
Bounds	Gets or sets bounds of this FieldBase object.
ForcePageBreak	Gets or sets a value determining whether to insert page breaks before or after the field.
Height	Gets or sets the height of the field in twips.
Hyperlink	Gets the hyperlink associated with the current field.
KeepTogether	Specifies whether the field should be kept together on a page.
Left	Gets or sets the X coordinate of the field's left edge in twips.
MarginBottom	Gets or sets the spacing between the bottom edge of the field and its content, in twips.
MarginLeft	Gets or sets the spacing between the left edge of the field and its content, in twips.
MarginRight	Gets or sets the spacing between the right edge of the field and its content, in twips.
MarginTop	Gets or sets the spacing between the top edge of the field and its content, in twips.
Name	Gets or sets the field name.
ParentReport	Gets the FlexReport containing this field.
RenderHeight	Gets the actual height of the current field. This property can only be used while the report is being rendered, otherwise it returns -1.
RenderLeft	Gets the actual left position of the current field in its subsection. This property can only be used while the report is being rendered, otherwise it returns -1.
RenderTop	Gets the actual top position of the current field in its subsection. This property can only be used while the report is being rendered, otherwise it returns -1.
RenderWidth	Gets the actual width of the current field. This property can only be used while the report is being rendered, otherwise it returns -1.
Right	Gets the x-coordinate of the field's right edge in twips.
RightToLeft	Gets or sets a value indicating whether right-to-left text rendering rules should be used. If null (which is the default), the property RightToLeft defined on the report is used.
Section	Gets or sets the section to which the field belongs.
SplitHorzBehavior	Gets or sets a value determining how the object is treated when it is too wide to fit in the horizontal space available on the current page.
SplitVertBehavior	Gets or sets a value determining how the object is treated when it is too high to fit in the vertical space available on the current page.
SubSection	Gets the SubSection object containing this field.
SubSectionIndex	Gets or sets the index of the SubSection in Section to which the field belongs.
Top	Gets or sets the Y coordinate of the field's top edge in twips.
Visible	Gets or sets a value indicating whether the field is visible or hidden.
Width	Gets or sets the width of the field in twips.
ZOrder	Gets or sets the ZOrder of the field.

Methods

Name	Description
AfterRender()	Called where report rendering finish. Can be used to finalize object after rendering.
AssignFrom(FieldBase)	Assigns (copies) properties from another FieldBase to the current object.
AssignFrom(ReportObject, bool)	Copies properties from another object into this object.
BuildStyleKey(StyleKey)
Clone()	Creates a new object that is a copy of the current FieldBase object.
GetClientHeight()
GetClientWidth()
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.
GetDefAutoHeight()
GetDefAutoWidth()
GetDefSplitHorzBehavior()
GetDefSplitVertBehavior()
GetFlag(int)
GetPropsTable()
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)
OnPropertyChanged()	Marks the owner report as dirty so it will clear the internal cache and render again.
OnSerializeAdded()	Post action after the field is added to the parent report's fields colleciton.
PrecalculateValues()	Called by rendering engine to precalculate field's value in the footer sections: report footer, group footers.
ResetState()	Called when FlexReport starts calculation of the section containing this FieldBase. Resets internal state of the field.
SetFlag(int, bool)
SetZOrder(bool)	Brings a field to the front or sends it to the back of the ZOrder.