Class ZipCodeObject

Represents a zip code object.

Inheritance
System.Object
Base
ComponentBase
ReportComponentBase
ZipCodeObject
Implements
Inherited Members
Namespace: FastReport
Assembly: FastReport.Base.dll
Syntax
public class ZipCodeObject : ReportComponentBase, IFRSerializable
Remarks

This object is mainly used in Russia to print postal index on envelopes. It complies with the GOST R 51506-99.

Constructors

ZipCodeObject()

Initializes a new instance of the ZipCodeObject with the default settings.

Declaration
public ZipCodeObject()

Properties

DataColumn

Gets or sets a data column name bound to this control.

Declaration
public string DataColumn { get; set; }
Property Value
Type Description
System.String
Remarks

Value must be in the form "Datasource.Column".

Expression

Gets or sets an expression that contains the zip code.

Declaration
public string Expression { get; set; }
Property Value
Type Description
System.String

SegmentCount

Gets or sets the number of segments in zipcode.

Declaration
public int SegmentCount { get; set; }
Property Value
Type Description
System.Int32

SegmentHeight

Gets or sets the height of a single zipcode segment, in pixels.

Declaration
public float SegmentHeight { get; set; }
Property Value
Type Description
System.Single

SegmentWidth

Gets or sets the width of a single zipcode segment, in pixels.

Declaration
public float SegmentWidth { get; set; }
Property Value
Type Description
System.Single

ShowGrid

Gets or sets a value indicating whether the segment grid should be drawn.

Declaration
public bool ShowGrid { get; set; }
Property Value
Type Description
System.Boolean

ShowMarkers

Gets or sets a value indicating whether the reference markers should be drawn.

Declaration
public bool ShowMarkers { get; set; }
Property Value
Type Description
System.Boolean
Remarks

Reference markers are used by postal service to automatically read the zipcode.

Spacing

Gets or sets the spacing between origins of segments, in pixels.

Declaration
public float Spacing { get; set; }
Property Value
Type Description
System.Single

Text

Gets or sets the zip code.

Declaration
public string Text { get; set; }
Property Value
Type Description
System.String

Methods

Assign(Base)

Copies the contents of another, similar object.

Declaration
public override void Assign(Base source)
Parameters
Type Name Description
Base source

Source object to copy the contents from.
Overrides
Remarks

Call Assign to copy the properties from another object of the same type. The standard form of a call to Assign is

destination.Assign(source);

which tells the destination object to copy the contents of the source object to itself. In this method, all child objects are ignored. If you want to copy child objects, use the AssignAll method.

See Also

Draw(FRPaintEventArgs)

Declaration
public override void Draw(FRPaintEventArgs e)
Parameters
Type Name Description
FRPaintEventArgs e
Overrides

GetData()

Gets the data from a datasource that the object is connected to.

Declaration
public override void GetData()
Overrides
Remarks

This method is called by the report engine before processing the object.

Do not call it directly. You may override it if you are developing a new FastReport component. In this method you should get the data from a datasource that the object is connected to.

GetDataAsync(CancellationToken)

Declaration
public override async Task GetDataAsync(CancellationToken cancellationToken)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken
Returns
Type Description
System.Threading.Tasks.Task
Overrides

GetExpressions()

Gets all expressions contained in the object.

Declaration
public override string[] GetExpressions()
Returns
Type Description
System.String[]

Array of expressions or null if object contains no expressions.
Overrides
Remarks

Do not call this method directly. You may override it if you are developing a new component for FastReport.

This method is called by FastReport each time before run a report. FastReport do this to collect all expressions and compile them. For example, GetExpressions method of the TextObject class parses the text and returns all expressions found in the text.

Serialize(FRWriter)

Serializes the object.

Declaration
public override void Serialize(FRWriter writer)
Parameters
Type Name Description
FRWriter writer

Writer object.
Overrides
Remarks

Do not call this method directly. You should override it if you are developing a new component for FastReport.

This method is called when the object needs to save the state. It may happen when:

  • saving the report to the file or stream;
  • saving the report to the designer's undo buffer;
  • assigning the object to another object using the Assign(Base) or AssignAll methods;
  • saving the object to the designer's clipboard;
  • saving the object to the preview (when run a report).

Implements