diff --git a/ClassReference/api/FastReport.AfterDatabaseLoginEventArgs.html b/ClassReference/api/FastReport.AfterDatabaseLoginEventArgs.html index e976783..e987f1c 100644 --- a/ClassReference/api/FastReport.AfterDatabaseLoginEventArgs.html +++ b/ClassReference/api/FastReport.AfterDatabaseLoginEventArgs.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.AfterDatabaseLoginEventHandler.html b/ClassReference/api/FastReport.AfterDatabaseLoginEventHandler.html index 203e8f3..ddc6099 100644 --- a/ClassReference/api/FastReport.AfterDatabaseLoginEventHandler.html +++ b/ClassReference/api/FastReport.AfterDatabaseLoginEventHandler.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.AssemblyInitializer.html b/ClassReference/api/FastReport.AssemblyInitializer.html index a6e4d83..3b6b35e 100644 --- a/ClassReference/api/FastReport.AssemblyInitializer.html +++ b/ClassReference/api/FastReport.AssemblyInitializer.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.AutoShrinkMode.html b/ClassReference/api/FastReport.AutoShrinkMode.html index 472e45c..ab3094a 100644 --- a/ClassReference/api/FastReport.AutoShrinkMode.html +++ b/ClassReference/api/FastReport.AutoShrinkMode.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.BandBase.html b/ClassReference/api/FastReport.BandBase.html index 115a5b0..81a9e22 100644 --- a/ClassReference/api/FastReport.BandBase.html +++ b/ClassReference/api/FastReport.BandBase.html @@ -10,7 +10,7 @@ - + @@ -119,9 +119,6 @@
Inherited Members
ReportComponentBase.Click
-
- ReportComponentBase.Printable -
ReportComponentBase.Exportable
@@ -233,6 +230,9 @@
Inherited Members
ReportComponentBase.IsVisible(FRPaintEventArgs)
+
+ ReportComponentBase.Deserialize(FRReader) +
ReportComponentBase.OnClick(EventArgs)
@@ -299,6 +299,9 @@
Inherited Members
ComponentBase.Visible
+
+ ComponentBase.Printable +
ComponentBase.Width
@@ -389,9 +392,6 @@
Inherited Members
Base.Clear()
-
- Base.Deserialize(FRReader) -
Base.BaseAssign(Base)
@@ -451,7 +451,8 @@

Properties

AbsLeft

-
+

Gets the absolute left coordinate of the object.

+
Declaration
@@ -504,7 +505,8 @@
Property Value

AbsTop

-
+

Gets the absolute top coordinate of the object.

+
Declaration
@@ -837,6 +839,32 @@
Property Value
+ +

RepeatBandNTimes

+

Gets or sets a value that determines the number of repetitions of the same band.

+
+
+
Declaration
+
+
public int RepeatBandNTimes { get; set; }
+
+
Property Value
+ + + + + + + + + + + + + +
TypeDescription
System.Int32
+ +

Repeated

Gets a value indicating that band is reprinted on a new page.

@@ -938,7 +966,8 @@

Methods

AddChild(Base)

-
+

Adds a child object to this object's childs.

+
Declaration
@@ -957,7 +986,8 @@
Parameters
Base child - +

Object to add.

+ @@ -965,7 +995,8 @@
Parameters

Assign(Base)

-
+

Copies the contents of another, similar object.

+
Declaration
@@ -984,17 +1015,34 @@
Parameters
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(Base) method. +

+
+
See Also
+

Break(BreakableComponent)

-
+

Breaks the contents of the object.

+
Declaration
@@ -1013,7 +1061,9 @@
Parameters
BreakableComponent breakTo - +

Object to put the part of content to that does not fit in this object. These two +objects must have the same type.

+ @@ -1028,17 +1078,30 @@
Returns
System.Boolean - +

true if there is enough space in this object to display at least one text line.

+
Overrides
+
Remarks
+

+Do not call this method directly, it is used by the report engine. You should override it if +you are writing a new FastReport object. +

+

+This method must break the contents of the object. The part of content that fit in current object's +bounds should remain in this object, the part that does not fit should be transferred to breakTo +object. +

+

CalcHeight()

-
+

Calculates the object's height.

+
Declaration
@@ -1055,17 +1118,23 @@
Returns
System.Single - +

Actual object's height, in pixels.

+
Overrides
+
Remarks
+

Applicable to objects that contain several text lines, such as TextObject. Returns the height needed +to display all the text lines.

+

CanContain(Base)

-
+

Gets a value indicating that this object can contain the specified child object.

+
Declaration
@@ -1084,7 +1153,8 @@
Parameters
Base child - +

Child object.

+ @@ -1099,7 +1169,8 @@
Returns
System.Boolean - +

true if this object can contain the specified child object; otherwise, false.

+ @@ -1107,7 +1178,8 @@
Returns

GetChildObjects(ObjectCollection)

-
+

Gets a list of child objects.

+
Declaration
@@ -1126,7 +1198,8 @@
Parameters
ObjectCollection list - +

List to fill with values.

+ @@ -1134,7 +1207,8 @@
Parameters

GetChildOrder(Base)

-
+

Returns z-order of the specified child object.

+
Declaration
@@ -1153,7 +1227,8 @@
Parameters
Base child - +

Child object.

+ @@ -1168,15 +1243,20 @@
Returns
System.Int32 - +

Z-order of the specified object.

+ +
Remarks
+

This method must return the index of a specified child object in the internal child list.

+

GetData()

-
+

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

+
Declaration
@@ -1184,11 +1264,17 @@
Declaration
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. +

GetExpressions()

-
+

Gets all expressions contained in the object.

+
Declaration
@@ -1205,17 +1291,29 @@
Returns
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. +

+

InitializeComponent()

-
+

Initializes the object before running a report.

+
Declaration
@@ -1223,6 +1321,9 @@
Declaration
Overrides
+
Remarks
+

This method is used by the report engine, do not call it directly.

+
@@ -1285,7 +1386,8 @@
Parameters

RemoveChild(Base)

-
+

Removes a specified object from this object's childs.

+
Declaration
@@ -1312,7 +1414,8 @@
Parameters

RestoreState()

-
+

Restores the object's state after printing it.

+
Declaration
@@ -1320,11 +1423,17 @@
Declaration
Overrides
+
Remarks
+

This method is called by the report engine after 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 restore the object properties that were saved by the SaveState() method. +

SaveState()

-
+

Saves the object's state before printing it.

+
Declaration
@@ -1332,11 +1441,18 @@
Declaration
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 save any object properties that may be changed during the object printing. +The standard implementation saves the object's bounds, visibility, bookmark and hyperlink. +

Serialize(FRWriter)

-
+

Serializes the object.

+
Declaration
@@ -1355,17 +1471,30 @@
Parameters
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(Base) methods; +
  • saving the object to the designer's clipboard;
  • saving the object to the preview (when run a +report).
+

SetChildOrder(Base, Int32)

-
+

Sets the z-order of the specified object.

+
Declaration
@@ -1384,20 +1513,26 @@
Parameters
Base child - +

Child object.

+ System.Int32 order - +

New Z-order.

+ +
Remarks
+

This method must place the specified child object at the specified position in the internal child list.

+

UpdateLayout(Single, Single)

-
+

Updates the children layout when the size of this object is changed by dx, dy values.

+
Declaration
@@ -1416,15 +1551,21 @@
Parameters
System.Single dx - +

X delta.

+ System.Single dy - +

Y delta.

+ +
Remarks
+

This method must update positions/sizes of child objects whose Dock or Anchor properties +are set to non-default values.

+

Events

diff --git a/ClassReference/api/FastReport.BandCollection.html b/ClassReference/api/FastReport.BandCollection.html index 963ea58..643b4a6 100644 --- a/ClassReference/api/FastReport.BandCollection.html +++ b/ClassReference/api/FastReport.BandCollection.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.BandColumns.html b/ClassReference/api/FastReport.BandColumns.html index 0ccb339..6adda73 100644 --- a/ClassReference/api/FastReport.BandColumns.html +++ b/ClassReference/api/FastReport.BandColumns.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Barcode.Barcode128.html b/ClassReference/api/FastReport.Barcode.Barcode128.html index fbf4cc1..363480f 100644 --- a/ClassReference/api/FastReport.Barcode.Barcode128.html +++ b/ClassReference/api/FastReport.Barcode.Barcode128.html @@ -10,7 +10,7 @@ - + @@ -95,6 +95,9 @@
Inherited Members
+ @@ -222,7 +225,8 @@
Examples

IsNumeric

-
+

Gets the value indicating that the barcode is numeric.

+
Declaration
@@ -251,7 +255,8 @@

Methods

Assign(BarcodeBase)

-
+

Assigns properties from other, similar barcode.

+
Declaration
@@ -270,7 +275,8 @@
Parameters
BarcodeBase source - +

Barcode object to assign properties from.

+ diff --git a/ClassReference/api/FastReport.Barcode.Barcode2DBase.html b/ClassReference/api/FastReport.Barcode.Barcode2DBase.html index a1ee2d3..7ad35e3 100644 --- a/ClassReference/api/FastReport.Barcode.Barcode2DBase.html +++ b/ClassReference/api/FastReport.Barcode.Barcode2DBase.html @@ -10,7 +10,7 @@ - + @@ -129,6 +129,42 @@
Syntax
public abstract class Barcode2DBase : BarcodeBase
+

Methods +

+ + + +

DrawBarcode(IGraphicsRenderer, RectangleF)

+
+
+
Declaration
+
+
public override void DrawBarcode(IGraphicsRenderer g, RectangleF displayRect)
+
+
Parameters
+ + + + + + + + + + + + + + + + + + + + +
TypeNameDescription
IGraphicsRendererg
RectangleFdisplayRect
+
Overrides
+
diff --git a/ClassReference/api/FastReport.Barcode.Barcode2of5Industrial.html b/ClassReference/api/FastReport.Barcode.Barcode2of5Industrial.html index 74e1616..167d84c 100644 --- a/ClassReference/api/FastReport.Barcode.Barcode2of5Industrial.html +++ b/ClassReference/api/FastReport.Barcode.Barcode2of5Industrial.html @@ -10,7 +10,7 @@ - + @@ -101,6 +101,9 @@
Inherited Members
+ diff --git a/ClassReference/api/FastReport.Barcode.Barcode2of5Interleaved.html b/ClassReference/api/FastReport.Barcode.Barcode2of5Interleaved.html index 7727685..b6a9309 100644 --- a/ClassReference/api/FastReport.Barcode.Barcode2of5Interleaved.html +++ b/ClassReference/api/FastReport.Barcode.Barcode2of5Interleaved.html @@ -10,7 +10,7 @@ - + @@ -102,6 +102,9 @@
Inherited Members
+ diff --git a/ClassReference/api/FastReport.Barcode.Barcode2of5Matrix.html b/ClassReference/api/FastReport.Barcode.Barcode2of5Matrix.html index d70c08e..e1314a2 100644 --- a/ClassReference/api/FastReport.Barcode.Barcode2of5Matrix.html +++ b/ClassReference/api/FastReport.Barcode.Barcode2of5Matrix.html @@ -10,7 +10,7 @@ - + @@ -101,6 +101,9 @@
Inherited Members
+ diff --git a/ClassReference/api/FastReport.Barcode.Barcode39.html b/ClassReference/api/FastReport.Barcode.Barcode39.html index 71e26e7..c3b0fad 100644 --- a/ClassReference/api/FastReport.Barcode.Barcode39.html +++ b/ClassReference/api/FastReport.Barcode.Barcode39.html @@ -10,7 +10,7 @@ - + @@ -98,6 +98,9 @@
Inherited Members
+ @@ -154,7 +157,8 @@

Properties

IsNumeric

-
+

Gets the value indicating that the barcode is numeric.

+
Declaration
diff --git a/ClassReference/api/FastReport.Barcode.Barcode39Extended.html b/ClassReference/api/FastReport.Barcode.Barcode39Extended.html index 4cb86bd..0e2f097 100644 --- a/ClassReference/api/FastReport.Barcode.Barcode39Extended.html +++ b/ClassReference/api/FastReport.Barcode.Barcode39Extended.html @@ -10,7 +10,7 @@ - + @@ -101,6 +101,9 @@
Inherited Members
+ diff --git a/ClassReference/api/FastReport.Barcode.Barcode93.html b/ClassReference/api/FastReport.Barcode.Barcode93.html index 6ff4497..6c08463 100644 --- a/ClassReference/api/FastReport.Barcode.Barcode93.html +++ b/ClassReference/api/FastReport.Barcode.Barcode93.html @@ -10,7 +10,7 @@ - + @@ -98,6 +98,9 @@
Inherited Members
+ @@ -141,7 +144,8 @@

Properties

IsNumeric

-
+

Gets the value indicating that the barcode is numeric.

+
Declaration
diff --git a/ClassReference/api/FastReport.Barcode.Barcode93Extended.html b/ClassReference/api/FastReport.Barcode.Barcode93Extended.html index 042e367..4388862 100644 --- a/ClassReference/api/FastReport.Barcode.Barcode93Extended.html +++ b/ClassReference/api/FastReport.Barcode.Barcode93Extended.html @@ -10,7 +10,7 @@ - + @@ -101,6 +101,9 @@
Inherited Members
+ diff --git a/ClassReference/api/FastReport.Barcode.BarcodeAztec.html b/ClassReference/api/FastReport.Barcode.BarcodeAztec.html index d29d080..e9787a9 100644 --- a/ClassReference/api/FastReport.Barcode.BarcodeAztec.html +++ b/ClassReference/api/FastReport.Barcode.BarcodeAztec.html @@ -10,7 +10,7 @@ - + @@ -85,6 +85,9 @@
Inheritance
Inherited Members
+ @@ -169,7 +172,8 @@

Methods

Assign(BarcodeBase)

-
+

Assigns properties from other, similar barcode.

+
Declaration
@@ -188,7 +192,8 @@
Parameters
BarcodeBase source - +

Barcode object to assign properties from.

+ diff --git a/ClassReference/api/FastReport.Barcode.BarcodeBase.html b/ClassReference/api/FastReport.Barcode.BarcodeBase.html index 53a8411..dd402d2 100644 --- a/ClassReference/api/FastReport.Barcode.BarcodeBase.html +++ b/ClassReference/api/FastReport.Barcode.BarcodeBase.html @@ -10,7 +10,7 @@ - + @@ -238,6 +238,38 @@
Returns
+ + + +

DrawBarcode(IGraphicsRenderer, RectangleF)

+
+
+
Declaration
+
+
public virtual void DrawBarcode(IGraphicsRenderer g, RectangleF displayRect)
+
+
Parameters
+ + + + + + + + + + + + + + + + + + + + +
TypeNameDescription
IGraphicsRendererg
RectangleFdisplayRect
diff --git a/ClassReference/api/FastReport.Barcode.BarcodeCodabar.html b/ClassReference/api/FastReport.Barcode.BarcodeCodabar.html index 96fa7d7..1aee741 100644 --- a/ClassReference/api/FastReport.Barcode.BarcodeCodabar.html +++ b/ClassReference/api/FastReport.Barcode.BarcodeCodabar.html @@ -10,7 +10,7 @@ - + @@ -97,6 +97,9 @@
Inherited Members
+ @@ -153,7 +156,8 @@

Properties

IsNumeric

-
+

Gets the value indicating that the barcode is numeric.

+
Declaration
diff --git a/ClassReference/api/FastReport.Barcode.BarcodeDatamatrix.html b/ClassReference/api/FastReport.Barcode.BarcodeDatamatrix.html index 75968b3..13bfdb2 100644 --- a/ClassReference/api/FastReport.Barcode.BarcodeDatamatrix.html +++ b/ClassReference/api/FastReport.Barcode.BarcodeDatamatrix.html @@ -10,7 +10,7 @@ - + @@ -85,6 +85,9 @@
Inheritance
Inherited Members
+ @@ -251,7 +254,8 @@

Methods

Assign(BarcodeBase)

-
+

Assigns properties from other, similar barcode.

+
Declaration
@@ -270,7 +274,8 @@
Parameters
BarcodeBase source - +

Barcode object to assign properties from.

+ diff --git a/ClassReference/api/FastReport.Barcode.BarcodeEAN.html b/ClassReference/api/FastReport.Barcode.BarcodeEAN.html index 7ba0326..0679442 100644 --- a/ClassReference/api/FastReport.Barcode.BarcodeEAN.html +++ b/ClassReference/api/FastReport.Barcode.BarcodeEAN.html @@ -10,7 +10,7 @@ - + @@ -103,6 +103,9 @@
Inherited Members
+ diff --git a/ClassReference/api/FastReport.Barcode.BarcodeEAN128.html b/ClassReference/api/FastReport.Barcode.BarcodeEAN128.html index 7dc217c..d31cbed 100644 --- a/ClassReference/api/FastReport.Barcode.BarcodeEAN128.html +++ b/ClassReference/api/FastReport.Barcode.BarcodeEAN128.html @@ -10,7 +10,7 @@ - + @@ -104,6 +104,9 @@
Inherited Members
+ diff --git a/ClassReference/api/FastReport.Barcode.BarcodeEAN13.html b/ClassReference/api/FastReport.Barcode.BarcodeEAN13.html index 01de207..4002f59 100644 --- a/ClassReference/api/FastReport.Barcode.BarcodeEAN13.html +++ b/ClassReference/api/FastReport.Barcode.BarcodeEAN13.html @@ -10,7 +10,7 @@ - + @@ -101,6 +101,9 @@
Inherited Members
+ diff --git a/ClassReference/api/FastReport.Barcode.BarcodeEAN8.html b/ClassReference/api/FastReport.Barcode.BarcodeEAN8.html index 365e5b8..0a75215 100644 --- a/ClassReference/api/FastReport.Barcode.BarcodeEAN8.html +++ b/ClassReference/api/FastReport.Barcode.BarcodeEAN8.html @@ -10,7 +10,7 @@ - + @@ -101,6 +101,9 @@
Inherited Members
+ diff --git a/ClassReference/api/FastReport.Barcode.BarcodeIntelligentMail.html b/ClassReference/api/FastReport.Barcode.BarcodeIntelligentMail.html index 30ea52b..cab12d0 100644 --- a/ClassReference/api/FastReport.Barcode.BarcodeIntelligentMail.html +++ b/ClassReference/api/FastReport.Barcode.BarcodeIntelligentMail.html @@ -10,7 +10,7 @@ - + @@ -94,6 +94,9 @@
Inherited Members
+ @@ -150,7 +153,8 @@

Properties

IsNumeric

-
+

Gets the value indicating that the barcode is numeric.

+
Declaration
@@ -205,7 +209,8 @@

Methods

Assign(BarcodeBase)

-
+

Assigns properties from other, similar barcode.

+
Declaration
@@ -224,7 +229,8 @@
Parameters
BarcodeBase source - +

Barcode object to assign properties from.

+ diff --git a/ClassReference/api/FastReport.Barcode.BarcodeMSI.html b/ClassReference/api/FastReport.Barcode.BarcodeMSI.html index e123fda..8c00eec 100644 --- a/ClassReference/api/FastReport.Barcode.BarcodeMSI.html +++ b/ClassReference/api/FastReport.Barcode.BarcodeMSI.html @@ -10,7 +10,7 @@ - + @@ -100,6 +100,9 @@
Inherited Members
+ diff --git a/ClassReference/api/FastReport.Barcode.BarcodeMaxiCode.html b/ClassReference/api/FastReport.Barcode.BarcodeMaxiCode.html index 2ab1f8f..0d36541 100644 --- a/ClassReference/api/FastReport.Barcode.BarcodeMaxiCode.html +++ b/ClassReference/api/FastReport.Barcode.BarcodeMaxiCode.html @@ -10,7 +10,7 @@ - + @@ -85,6 +85,9 @@
Inheritance
Inherited Members
+ @@ -169,7 +172,8 @@

Methods

Assign(BarcodeBase)

-
+

Assigns properties from other, similar barcode.

+
Declaration
@@ -188,7 +192,8 @@
Parameters
BarcodeBase source - +

Barcode object to assign properties from.

+ diff --git a/ClassReference/api/FastReport.Barcode.BarcodeObject.html b/ClassReference/api/FastReport.Barcode.BarcodeObject.html index 51e9769..cdd09a9 100644 --- a/ClassReference/api/FastReport.Barcode.BarcodeObject.html +++ b/ClassReference/api/FastReport.Barcode.BarcodeObject.html @@ -10,7 +10,7 @@ - + @@ -103,9 +103,6 @@
Inherited Members
- @@ -214,6 +211,9 @@
Inherited Members
+ @@ -292,6 +292,9 @@
Inherited Members
+ @@ -382,9 +385,6 @@
Inherited Members
- @@ -870,7 +870,8 @@

Methods

Assign(Base)

-
+

Copies the contents of another, similar object.

+
Declaration
@@ -889,12 +890,28 @@
Parameters
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(Base) method. +

+
+
See Also
+ @@ -928,7 +945,8 @@
Overrides

GetData()

-
+

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

+
Declaration
@@ -936,11 +954,17 @@
Declaration
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. +

GetExpressions()

-
+

Gets all expressions contained in the object.

+
Declaration
@@ -957,17 +981,29 @@
Returns
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. +

+

RestoreState()

-
+

Restores the object's state after printing it.

+
Declaration
@@ -975,11 +1011,17 @@
Declaration
Overrides
+
Remarks
+

This method is called by the report engine after 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 restore the object properties that were saved by the SaveState() method. +

SaveState()

-
+

Saves the object's state before printing it.

+
Declaration
@@ -987,11 +1029,18 @@
Declaration
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 save any object properties that may be changed during the object printing. +The standard implementation saves the object's bounds, visibility, bookmark and hyperlink. +

Serialize(FRWriter)

-
+

Serializes the object.

+
Declaration
@@ -1010,12 +1059,34 @@
Parameters
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(Base) methods; +
  • saving the object to the designer's clipboard;
  • saving the object to the preview (when run a +report).
+
+ + + +

UpdateAutoSize()

+
+
+
Declaration
+
+
public void UpdateAutoSize()
+

Implements

IFRSerializable diff --git a/ClassReference/api/FastReport.Barcode.BarcodePDF417.html b/ClassReference/api/FastReport.Barcode.BarcodePDF417.html index 57a2e2e..5b0cb13 100644 --- a/ClassReference/api/FastReport.Barcode.BarcodePDF417.html +++ b/ClassReference/api/FastReport.Barcode.BarcodePDF417.html @@ -10,7 +10,7 @@ - + @@ -85,6 +85,9 @@
Inheritance
Inherited Members
+ @@ -349,7 +352,8 @@

Methods

Assign(BarcodeBase)

-
+

Assigns properties from other, similar barcode.

+
Declaration
@@ -368,7 +372,8 @@
Parameters
BarcodeBase source - +

Barcode object to assign properties from.

+ diff --git a/ClassReference/api/FastReport.Barcode.BarcodePharmacode.html b/ClassReference/api/FastReport.Barcode.BarcodePharmacode.html index 4deb18e..fa0615e 100644 --- a/ClassReference/api/FastReport.Barcode.BarcodePharmacode.html +++ b/ClassReference/api/FastReport.Barcode.BarcodePharmacode.html @@ -10,7 +10,7 @@ - + @@ -94,6 +94,9 @@
Inherited Members
+ @@ -150,7 +153,8 @@

Properties

IsNumeric

-
+

Gets the value indicating that the barcode is numeric.

+
Declaration
@@ -205,7 +209,8 @@

Methods

Assign(BarcodeBase)

-
+

Assigns properties from other, similar barcode.

+
Declaration
@@ -224,7 +229,8 @@
Parameters
BarcodeBase source - +

Barcode object to assign properties from.

+ diff --git a/ClassReference/api/FastReport.Barcode.BarcodePlessey.html b/ClassReference/api/FastReport.Barcode.BarcodePlessey.html index 114dd26..afe57f2 100644 --- a/ClassReference/api/FastReport.Barcode.BarcodePlessey.html +++ b/ClassReference/api/FastReport.Barcode.BarcodePlessey.html @@ -10,7 +10,7 @@ - + @@ -100,6 +100,9 @@
Inherited Members
+ diff --git a/ClassReference/api/FastReport.Barcode.BarcodePostNet.html b/ClassReference/api/FastReport.Barcode.BarcodePostNet.html index f029651..a188e41 100644 --- a/ClassReference/api/FastReport.Barcode.BarcodePostNet.html +++ b/ClassReference/api/FastReport.Barcode.BarcodePostNet.html @@ -10,7 +10,7 @@ - + @@ -100,6 +100,9 @@
Inherited Members
+ diff --git a/ClassReference/api/FastReport.Barcode.BarcodeQR.html b/ClassReference/api/FastReport.Barcode.BarcodeQR.html index 5583ca1..faef4db 100644 --- a/ClassReference/api/FastReport.Barcode.BarcodeQR.html +++ b/ClassReference/api/FastReport.Barcode.BarcodeQR.html @@ -10,7 +10,7 @@ - + @@ -85,6 +85,9 @@
Inheritance
Inherited Members
+ @@ -221,7 +224,8 @@

Methods

Assign(BarcodeBase)

-
+

Assigns properties from other, similar barcode.

+
Declaration
@@ -240,7 +244,8 @@
Parameters
BarcodeBase source - +

Barcode object to assign properties from.

+ diff --git a/ClassReference/api/FastReport.Barcode.BarcodeSupplement2.html b/ClassReference/api/FastReport.Barcode.BarcodeSupplement2.html index 9699af0..c16c11a 100644 --- a/ClassReference/api/FastReport.Barcode.BarcodeSupplement2.html +++ b/ClassReference/api/FastReport.Barcode.BarcodeSupplement2.html @@ -10,7 +10,7 @@ - + @@ -102,6 +102,9 @@
Inherited Members
+ diff --git a/ClassReference/api/FastReport.Barcode.BarcodeUPC_A.html b/ClassReference/api/FastReport.Barcode.BarcodeUPC_A.html index 23a9d77..49325af 100644 --- a/ClassReference/api/FastReport.Barcode.BarcodeUPC_A.html +++ b/ClassReference/api/FastReport.Barcode.BarcodeUPC_A.html @@ -10,7 +10,7 @@ - + @@ -102,6 +102,9 @@
Inherited Members
+ diff --git a/ClassReference/api/FastReport.Barcode.BarcodeUPC_E0.html b/ClassReference/api/FastReport.Barcode.BarcodeUPC_E0.html index 37f4ade..a7384c9 100644 --- a/ClassReference/api/FastReport.Barcode.BarcodeUPC_E0.html +++ b/ClassReference/api/FastReport.Barcode.BarcodeUPC_E0.html @@ -10,7 +10,7 @@ - + @@ -104,6 +104,9 @@
Inherited Members
+ diff --git a/ClassReference/api/FastReport.Barcode.BarcodeUPC_E1.html b/ClassReference/api/FastReport.Barcode.BarcodeUPC_E1.html index 01c99a2..7a6f425 100644 --- a/ClassReference/api/FastReport.Barcode.BarcodeUPC_E1.html +++ b/ClassReference/api/FastReport.Barcode.BarcodeUPC_E1.html @@ -10,7 +10,7 @@ - + @@ -102,6 +102,9 @@
Inherited Members
+ diff --git a/ClassReference/api/FastReport.Barcode.DatamatrixEncoding.html b/ClassReference/api/FastReport.Barcode.DatamatrixEncoding.html index f6a3e17..9674868 100644 --- a/ClassReference/api/FastReport.Barcode.DatamatrixEncoding.html +++ b/ClassReference/api/FastReport.Barcode.DatamatrixEncoding.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Barcode.DatamatrixSymbolSize.html b/ClassReference/api/FastReport.Barcode.DatamatrixSymbolSize.html index 33238af..83d77b2 100644 --- a/ClassReference/api/FastReport.Barcode.DatamatrixSymbolSize.html +++ b/ClassReference/api/FastReport.Barcode.DatamatrixSymbolSize.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Barcode.LinearBarcodeBase.html b/ClassReference/api/FastReport.Barcode.LinearBarcodeBase.html index e6c6c77..9f77d80 100644 --- a/ClassReference/api/FastReport.Barcode.LinearBarcodeBase.html +++ b/ClassReference/api/FastReport.Barcode.LinearBarcodeBase.html @@ -10,7 +10,7 @@ - + @@ -259,7 +259,8 @@

Methods

Assign(BarcodeBase)

-
+

Assigns properties from other, similar barcode.

+
Declaration
@@ -278,12 +279,47 @@
Parameters
BarcodeBase source - +

Barcode object to assign properties from.

+
Overrides
+ + + +

DrawBarcode(IGraphicsRenderer, RectangleF)

+
+
+
Declaration
+
+
public override void DrawBarcode(IGraphicsRenderer g, RectangleF displayRect)
+
+
Parameters
+ + + + + + + + + + + + + + + + + + + + +
TypeNameDescription
IGraphicsRendererg
RectangleFdisplayRect
+
Overrides
+
diff --git a/ClassReference/api/FastReport.Barcode.PDF417CompactionMode.html b/ClassReference/api/FastReport.Barcode.PDF417CompactionMode.html index 3150e31..2b8d2c3 100644 --- a/ClassReference/api/FastReport.Barcode.PDF417CompactionMode.html +++ b/ClassReference/api/FastReport.Barcode.PDF417CompactionMode.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Barcode.PDF417ErrorCorrection.html b/ClassReference/api/FastReport.Barcode.PDF417ErrorCorrection.html index 0d9e13b..acb29f7 100644 --- a/ClassReference/api/FastReport.Barcode.PDF417ErrorCorrection.html +++ b/ClassReference/api/FastReport.Barcode.PDF417ErrorCorrection.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Barcode.QRCodeEncoding.html b/ClassReference/api/FastReport.Barcode.QRCodeEncoding.html index cc30d2a..b548755 100644 --- a/ClassReference/api/FastReport.Barcode.QRCodeEncoding.html +++ b/ClassReference/api/FastReport.Barcode.QRCodeEncoding.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Barcode.QRCodeErrorCorrection.html b/ClassReference/api/FastReport.Barcode.QRCodeErrorCorrection.html index e071d44..aa8e24a 100644 --- a/ClassReference/api/FastReport.Barcode.QRCodeErrorCorrection.html +++ b/ClassReference/api/FastReport.Barcode.QRCodeErrorCorrection.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Barcode.html b/ClassReference/api/FastReport.Barcode.html index 7f2425a..2b51b64 100644 --- a/ClassReference/api/FastReport.Barcode.html +++ b/ClassReference/api/FastReport.Barcode.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Base.html b/ClassReference/api/FastReport.Base.html index 37338f7..904d71f 100644 --- a/ClassReference/api/FastReport.Base.html +++ b/ClassReference/api/FastReport.Base.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Border.html b/ClassReference/api/FastReport.Border.html index 62c1602..33af09c 100644 --- a/ClassReference/api/FastReport.Border.html +++ b/ClassReference/api/FastReport.Border.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.BorderLine.html b/ClassReference/api/FastReport.BorderLine.html index 4a59ed3..864e9c2 100644 --- a/ClassReference/api/FastReport.BorderLine.html +++ b/ClassReference/api/FastReport.BorderLine.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.BorderLines.html b/ClassReference/api/FastReport.BorderLines.html index ac90d8b..576f7e4 100644 --- a/ClassReference/api/FastReport.BorderLines.html +++ b/ClassReference/api/FastReport.BorderLines.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.BreakableComponent.html b/ClassReference/api/FastReport.BreakableComponent.html index da01c53..18c440d 100644 --- a/ClassReference/api/FastReport.BreakableComponent.html +++ b/ClassReference/api/FastReport.BreakableComponent.html @@ -10,7 +10,7 @@ - + @@ -105,9 +105,6 @@
Inherited Members
- @@ -219,6 +216,9 @@
Inherited Members
+ @@ -309,6 +309,9 @@
Inherited Members
+ @@ -399,9 +402,6 @@
Inherited Members
- @@ -516,7 +516,8 @@

Methods

Assign(Base)

-
+

Copies the contents of another, similar object.

+
Declaration
@@ -535,12 +536,28 @@
Parameters
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(Base) method. +

+
+
See Also
+ @@ -602,7 +619,8 @@

Serialize(FRWriter)

-
+

Serializes the object.

+
Declaration
@@ -621,12 +639,24 @@
Parameters
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(Base) methods; +
  • saving the object to the designer's clipboard;
  • saving the object to the preview (when run a +report).
+

Implements

IFRSerializable diff --git a/ClassReference/api/FastReport.CapSettings.html b/ClassReference/api/FastReport.CapSettings.html index 92ba736..9662e39 100644 --- a/ClassReference/api/FastReport.CapSettings.html +++ b/ClassReference/api/FastReport.CapSettings.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.CapStyle.html b/ClassReference/api/FastReport.CapStyle.html index 9900612..63bf6ed 100644 --- a/ClassReference/api/FastReport.CapStyle.html +++ b/ClassReference/api/FastReport.CapStyle.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.CellularTextObject.html b/ClassReference/api/FastReport.CellularTextObject.html index 7fc513d..8f6040a 100644 --- a/ClassReference/api/FastReport.CellularTextObject.html +++ b/ClassReference/api/FastReport.CellularTextObject.html @@ -10,7 +10,7 @@ - + @@ -180,6 +180,9 @@
Inherited Members
+ @@ -195,6 +198,12 @@
Inherited Members
+ + @@ -273,9 +282,6 @@
Inherited Members
- @@ -384,12 +390,6 @@
Inherited Members
- - @@ -450,6 +450,9 @@
Inherited Members
+ @@ -716,7 +719,8 @@

Methods

Assign(Base)

-
+

Copies the contents of another, similar object.

+
Declaration
@@ -735,17 +739,34 @@
Parameters
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(Base) method. +

+
+
See Also
+

CalcHeight()

-
+

Calculates the object's height.

+
Declaration
@@ -762,12 +783,17 @@
Returns
System.Single - +

Actual object's height, in pixels.

+
Overrides
+
Remarks
+

Applicable to objects that contain several text lines, such as TextObject. Returns the height needed +to display all the text lines.

+
@@ -799,9 +825,35 @@
Overrides
+ +

GetTable()

+
+
+
Declaration
+
+
public TableObject GetTable()
+
+
Returns
+ + + + + + + + + + + + + +
TypeDescription
TableObject
+ +

Serialize(FRWriter)

-
+

Serializes the object.

+
Declaration
@@ -820,12 +872,24 @@
Parameters
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(Base) methods; +
  • saving the object to the designer's clipboard;
  • saving the object to the preview (when run a +report).
+

Implements

IFRSerializable diff --git a/ClassReference/api/FastReport.CheckBoxObject.html b/ClassReference/api/FastReport.CheckBoxObject.html index 912934f..974bfe5 100644 --- a/ClassReference/api/FastReport.CheckBoxObject.html +++ b/ClassReference/api/FastReport.CheckBoxObject.html @@ -10,7 +10,7 @@ - + @@ -102,9 +102,6 @@
Inherited Members
- @@ -213,6 +210,9 @@
Inherited Members
+ @@ -297,6 +297,9 @@
Inherited Members
+ @@ -387,9 +390,6 @@
Inherited Members
- @@ -691,7 +691,8 @@

Methods

Assign(Base)

-
+

Copies the contents of another, similar object.

+
Declaration
@@ -710,12 +711,28 @@
Parameters
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(Base) method. +

+
+
See Also
+ @@ -749,7 +766,8 @@
Overrides

GetData()

-
+

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

+
Declaration
@@ -757,11 +775,17 @@
Declaration
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. +

GetExpressions()

-
+

Gets all expressions contained in the object.

+
Declaration
@@ -778,17 +802,29 @@
Returns
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
@@ -807,12 +843,24 @@
Parameters
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(Base) methods; +
  • saving the object to the designer's clipboard;
  • saving the object to the preview (when run a +report).
+

Implements

IFRSerializable diff --git a/ClassReference/api/FastReport.CheckedSymbol.html b/ClassReference/api/FastReport.CheckedSymbol.html index 06b5aa5..e8b2e74 100644 --- a/ClassReference/api/FastReport.CheckedSymbol.html +++ b/ClassReference/api/FastReport.CheckedSymbol.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.ChildBand.html b/ClassReference/api/FastReport.ChildBand.html index 467cc93..b87d12f 100644 --- a/ClassReference/api/FastReport.ChildBand.html +++ b/ClassReference/api/FastReport.ChildBand.html @@ -10,7 +10,7 @@ - + @@ -102,6 +102,9 @@
Inherited Members
+ @@ -216,9 +219,6 @@
Inherited Members
- @@ -330,6 +330,9 @@
Inherited Members
+ @@ -396,6 +399,9 @@
Inherited Members
+ @@ -486,9 +492,6 @@
Inherited Members
- @@ -631,7 +634,8 @@

Methods

Assign(Base)

-
+

Copies the contents of another, similar object.

+
Declaration
@@ -650,17 +654,34 @@
Parameters
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(Base) method. +

+
+
See Also
+

Serialize(FRWriter)

-
+

Serializes the object.

+
Declaration
@@ -679,12 +700,24 @@
Parameters
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(Base) methods; +
  • saving the object to the designer's clipboard;
  • saving the object to the preview (when run a +report).
+

Implements

IFRSerializable diff --git a/ClassReference/api/FastReport.Code.CodeUtils.html b/ClassReference/api/FastReport.Code.CodeUtils.html index c1daf57..e617817 100644 --- a/ClassReference/api/FastReport.Code.CodeUtils.html +++ b/ClassReference/api/FastReport.Code.CodeUtils.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Code.FindTextArgs.html b/ClassReference/api/FastReport.Code.FindTextArgs.html index 41251e4..50bbca3 100644 --- a/ClassReference/api/FastReport.Code.FindTextArgs.html +++ b/ClassReference/api/FastReport.Code.FindTextArgs.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Code.html b/ClassReference/api/FastReport.Code.html index 97d5799..536bab7 100644 --- a/ClassReference/api/FastReport.Code.html +++ b/ClassReference/api/FastReport.Code.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.ColumnFooterBand.html b/ClassReference/api/FastReport.ColumnFooterBand.html index 23756cc..de9d663 100644 --- a/ClassReference/api/FastReport.ColumnFooterBand.html +++ b/ClassReference/api/FastReport.ColumnFooterBand.html @@ -10,7 +10,7 @@ - + @@ -99,6 +99,9 @@
Inherited Members
+ @@ -216,9 +219,6 @@
Inherited Members
- @@ -330,6 +330,9 @@
Inherited Members
+ @@ -396,6 +399,9 @@
Inherited Members
+ @@ -486,9 +492,6 @@
Inherited Members
- diff --git a/ClassReference/api/FastReport.ColumnHeaderBand.html b/ClassReference/api/FastReport.ColumnHeaderBand.html index 8f09813..1ea144b 100644 --- a/ClassReference/api/FastReport.ColumnHeaderBand.html +++ b/ClassReference/api/FastReport.ColumnHeaderBand.html @@ -10,7 +10,7 @@ - + @@ -99,6 +99,9 @@
Inherited Members
+ @@ -216,9 +219,6 @@
Inherited Members
- @@ -330,6 +330,9 @@
Inherited Members
+ @@ -396,6 +399,9 @@
Inherited Members
+ @@ -486,9 +492,6 @@
Inherited Members
- diff --git a/ClassReference/api/FastReport.ColumnLayout.html b/ClassReference/api/FastReport.ColumnLayout.html index da7e50e..1b7992a 100644 --- a/ClassReference/api/FastReport.ColumnLayout.html +++ b/ClassReference/api/FastReport.ColumnLayout.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.ComponentBase.html b/ClassReference/api/FastReport.ComponentBase.html index eb7b664..5c42fe1 100644 --- a/ClassReference/api/FastReport.ComponentBase.html +++ b/ClassReference/api/FastReport.ComponentBase.html @@ -10,7 +10,7 @@ - + @@ -643,6 +643,36 @@
Examples
+ +

Printable

+

Gets or sets a value that determines if the object can be printed on the printer.

+
+
+
Declaration
+
+
public bool Printable { get; set; }
+
+
Property Value
+ + + + + + + + + + + + + +
TypeDescription
System.Boolean
+
Remarks
+

Object with Printable = false is still visible in the preview window, but not on the printout. +If you want to hide an object in the preview, set the Visible property to false.

+
+ +

Right

Gets the right coordinate of the object in relation to its container.

@@ -817,7 +847,8 @@

Methods

Assign(Base)

-
+

Copies the contents of another, similar object.

+
Declaration
@@ -836,17 +867,34 @@
Parameters
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(Base) method. +

+
+
See Also
+

Serialize(FRWriter)

-
+

Serializes the object.

+
Declaration
@@ -865,12 +913,24 @@
Parameters
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(Base) methods; +
  • saving the object to the designer's clipboard;
  • saving the object to the preview (when run a +report).
+

Implements

IFRSerializable diff --git a/ClassReference/api/FastReport.ConditionCollection.html b/ClassReference/api/FastReport.ConditionCollection.html index 97334b5..186b57c 100644 --- a/ClassReference/api/FastReport.ConditionCollection.html +++ b/ClassReference/api/FastReport.ConditionCollection.html @@ -10,7 +10,7 @@ - + @@ -402,7 +402,8 @@
Returns

Deserialize(FRReader)

-
+

Deserializes the object.

+
Declaration
@@ -421,7 +422,8 @@
Parameters
FRReader reader - +

Reader object.

+ @@ -610,7 +612,8 @@
Parameters

Serialize(FRWriter)

-
+

Serializes the object.

+
Declaration
@@ -629,7 +632,8 @@
Parameters
FRWriter writer - +

Writer object.

+ diff --git a/ClassReference/api/FastReport.CrossView.CrossViewAxisDrawCell.html b/ClassReference/api/FastReport.CrossView.CrossViewAxisDrawCell.html index 558f61e..c3fa164 100644 --- a/ClassReference/api/FastReport.CrossView.CrossViewAxisDrawCell.html +++ b/ClassReference/api/FastReport.CrossView.CrossViewAxisDrawCell.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.CrossView.CrossViewAxisDrawCellHandler.html b/ClassReference/api/FastReport.CrossView.CrossViewAxisDrawCellHandler.html index 43c662d..9dd823c 100644 --- a/ClassReference/api/FastReport.CrossView.CrossViewAxisDrawCellHandler.html +++ b/ClassReference/api/FastReport.CrossView.CrossViewAxisDrawCellHandler.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.CrossView.CrossViewCellDescriptor.html b/ClassReference/api/FastReport.CrossView.CrossViewCellDescriptor.html index d42e250..e141627 100644 --- a/ClassReference/api/FastReport.CrossView.CrossViewCellDescriptor.html +++ b/ClassReference/api/FastReport.CrossView.CrossViewCellDescriptor.html @@ -10,7 +10,7 @@ - + @@ -458,7 +458,8 @@

Methods

Assign(CrossViewDescriptor)

-
+

Assigns values from another descriptor.

+
Declaration
@@ -477,7 +478,8 @@
Parameters
CrossViewDescriptor source - +

Descriptor to assign values from.

+ @@ -487,7 +489,8 @@
Overrides

Serialize(FRWriter)

-
+

Serializes the object.

+
Declaration
@@ -506,7 +509,8 @@
Parameters
FRWriter writer - +

Writer object.

+ diff --git a/ClassReference/api/FastReport.CrossView.CrossViewCells.html b/ClassReference/api/FastReport.CrossView.CrossViewCells.html index 4cff4be..700582c 100644 --- a/ClassReference/api/FastReport.CrossView.CrossViewCells.html +++ b/ClassReference/api/FastReport.CrossView.CrossViewCells.html @@ -10,7 +10,7 @@ - + @@ -271,7 +271,8 @@

Methods

Deserialize(FRReader)

-
+

Deserializes the object.

+
Declaration
@@ -290,7 +291,8 @@
Parameters
FRReader reader - +

Reader object.

+ @@ -298,7 +300,8 @@
Parameters

Serialize(FRWriter)

-
+

Serializes the object.

+
Declaration
@@ -317,7 +320,8 @@
Parameters
FRWriter writer - +

Writer object.

+ diff --git a/ClassReference/api/FastReport.CrossView.CrossViewData.html b/ClassReference/api/FastReport.CrossView.CrossViewData.html index 218abc7..e2faff7 100644 --- a/ClassReference/api/FastReport.CrossView.CrossViewData.html +++ b/ClassReference/api/FastReport.CrossView.CrossViewData.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.CrossView.CrossViewDescriptor.html b/ClassReference/api/FastReport.CrossView.CrossViewDescriptor.html index cd2ae08..6e21377 100644 --- a/ClassReference/api/FastReport.CrossView.CrossViewDescriptor.html +++ b/ClassReference/api/FastReport.CrossView.CrossViewDescriptor.html @@ -10,7 +10,7 @@ - + @@ -282,7 +282,8 @@
Parameters

Deserialize(FRReader)

-
+

Deserializes the object.

+
Declaration
@@ -301,7 +302,8 @@
Parameters
FRReader reader - +

Reader object.

+ @@ -309,7 +311,8 @@
Parameters

Serialize(FRWriter)

-
+

Serializes the object.

+
Declaration
@@ -328,7 +331,8 @@
Parameters
FRWriter writer - +

Writer object.

+ diff --git a/ClassReference/api/FastReport.CrossView.CrossViewHeader.html b/ClassReference/api/FastReport.CrossView.CrossViewHeader.html index 2d7838d..d7dde7c 100644 --- a/ClassReference/api/FastReport.CrossView.CrossViewHeader.html +++ b/ClassReference/api/FastReport.CrossView.CrossViewHeader.html @@ -10,7 +10,7 @@ - + @@ -271,7 +271,8 @@

Methods

Deserialize(FRReader)

-
+

Deserializes the object.

+
Declaration
@@ -290,7 +291,8 @@
Parameters
FRReader reader - +

Reader object.

+ @@ -298,7 +300,8 @@
Parameters

Serialize(FRWriter)

-
+

Serializes the object.

+
Declaration
@@ -317,7 +320,8 @@
Parameters
FRWriter writer - +

Writer object.

+ diff --git a/ClassReference/api/FastReport.CrossView.CrossViewHeaderDescriptor.html b/ClassReference/api/FastReport.CrossView.CrossViewHeaderDescriptor.html index 8ba73a1..53316b9 100644 --- a/ClassReference/api/FastReport.CrossView.CrossViewHeaderDescriptor.html +++ b/ClassReference/api/FastReport.CrossView.CrossViewHeaderDescriptor.html @@ -10,7 +10,7 @@ - + @@ -447,7 +447,8 @@

Methods

Assign(CrossViewDescriptor)

-
+

Assigns values from another descriptor.

+
Declaration
@@ -466,7 +467,8 @@
Parameters
CrossViewDescriptor source - +

Descriptor to assign values from.

+ @@ -476,7 +478,8 @@
Overrides

Serialize(FRWriter)

-
+

Serializes the object.

+
Declaration
@@ -495,7 +498,8 @@
Parameters
FRWriter writer - +

Writer object.

+ diff --git a/ClassReference/api/FastReport.CrossView.CrossViewMeasureCell.html b/ClassReference/api/FastReport.CrossView.CrossViewMeasureCell.html index 7edaafd..189120e 100644 --- a/ClassReference/api/FastReport.CrossView.CrossViewMeasureCell.html +++ b/ClassReference/api/FastReport.CrossView.CrossViewMeasureCell.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.CrossView.CrossViewObject.html b/ClassReference/api/FastReport.CrossView.CrossViewObject.html index 5289830..51d9f5f 100644 --- a/ClassReference/api/FastReport.CrossView.CrossViewObject.html +++ b/ClassReference/api/FastReport.CrossView.CrossViewObject.html @@ -10,7 +10,7 @@ - + @@ -144,6 +144,9 @@
Inherited Members
+ @@ -210,9 +213,6 @@
Inherited Members
- @@ -315,6 +315,9 @@
Inherited Members
+ @@ -387,6 +390,9 @@
Inherited Members
+ @@ -474,9 +480,6 @@
Inherited Members
- @@ -827,7 +830,8 @@

Methods

Assign(Base)

-
+

Copies the contents of another, similar object.

+
Declaration
@@ -846,12 +850,28 @@
Parameters
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(Base) method. +

+
+
See Also
+ @@ -871,7 +891,8 @@
Remarks

DeserializeSubItems(FRReader)

-
+

Deserializes nested object properties.

+
Declaration
@@ -890,17 +911,29 @@
Parameters
FRReader reader - +

Reader object.

+
Overrides
+
Remarks
+

Typically the object serializes all properties to the single xml item:

+
<TextObject Name="Text2" Left="18.9" Top="37.8" Width="283.5" Height="28.35"/>
+

Some objects like DataBand have child objects that serialized in subitems:

+
<DataBand Name="Data1" Top="163" Width="718.2" Height="18.9">
+  <TextObject Name="Text3" Left="18.9" Top="37.8" Width="283.5" Height="28.35"/>
+</DataBand>
+

To read such subitems, the DeserializeSubItems method is used. Base +implementation reads the child objects. You may override it to read some specific subitems.

+

FinalizeComponent()

-
+

Performs a finalization after the report is finished.

+
Declaration
@@ -908,11 +941,15 @@
Declaration
Overrides
+
Remarks
+

This method is used by the report engine, do not call it directly.

+

GetData()

-
+

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

+
Declaration
@@ -920,11 +957,17 @@
Declaration
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. +

InitializeComponent()

-
+

Initializes the object before running a report.

+
Declaration
@@ -932,6 +975,9 @@
Declaration
Overrides
+
Remarks
+

This method is used by the report engine, do not call it directly.

+
@@ -965,7 +1011,8 @@
Parameters

RestoreState()

-
+

Restores the object's state after printing it.

+
Declaration
@@ -973,11 +1020,17 @@
Declaration
Overrides
+
Remarks
+

This method is called by the report engine after 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 restore the object properties that were saved by the SaveState() method. +

SaveState()

-
+

Saves the object's state before printing it.

+
Declaration
@@ -985,11 +1038,18 @@
Declaration
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 save any object properties that may be changed during the object printing. +The standard implementation saves the object's bounds, visibility, bookmark and hyperlink. +

Serialize(FRWriter)

-
+

Serializes the object.

+
Declaration
@@ -1008,12 +1068,24 @@
Parameters
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(Base) methods; +
  • saving the object to the designer's clipboard;
  • saving the object to the preview (when run a +report).
+

Events

diff --git a/ClassReference/api/FastReport.CrossView.IBaseCubeLink.html b/ClassReference/api/FastReport.CrossView.IBaseCubeLink.html index fa728a8..213798a 100644 --- a/ClassReference/api/FastReport.CrossView.IBaseCubeLink.html +++ b/ClassReference/api/FastReport.CrossView.IBaseCubeLink.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.CrossView.html b/ClassReference/api/FastReport.CrossView.html index 52c7e01..2f53dde 100644 --- a/ClassReference/api/FastReport.CrossView.html +++ b/ClassReference/api/FastReport.CrossView.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.CustomCalcEventArgs.html b/ClassReference/api/FastReport.CustomCalcEventArgs.html index 5f03006..3f19ed0 100644 --- a/ClassReference/api/FastReport.CustomCalcEventArgs.html +++ b/ClassReference/api/FastReport.CustomCalcEventArgs.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.CustomCalcEventHandler.html b/ClassReference/api/FastReport.CustomCalcEventHandler.html index 3ded1ef..94dcf37 100644 --- a/ClassReference/api/FastReport.CustomCalcEventHandler.html +++ b/ClassReference/api/FastReport.CustomCalcEventHandler.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.CustomLoadEventArgs.html b/ClassReference/api/FastReport.CustomLoadEventArgs.html index 61398d8..eabfe5c 100644 --- a/ClassReference/api/FastReport.CustomLoadEventArgs.html +++ b/ClassReference/api/FastReport.CustomLoadEventArgs.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.CustomLoadEventHandler.html b/ClassReference/api/FastReport.CustomLoadEventHandler.html index d2f3981..710f3a9 100644 --- a/ClassReference/api/FastReport.CustomLoadEventHandler.html +++ b/ClassReference/api/FastReport.CustomLoadEventHandler.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Data.AbsRowVariable.html b/ClassReference/api/FastReport.Data.AbsRowVariable.html index f27a66c..d757701 100644 --- a/ClassReference/api/FastReport.Data.AbsRowVariable.html +++ b/ClassReference/api/FastReport.Data.AbsRowVariable.html @@ -10,7 +10,7 @@ - + @@ -278,7 +278,8 @@

Properties

Value

-
+

Gets or sets the value of parameter.

+
Declaration
@@ -301,6 +302,10 @@
Property Value
Overrides
+
Remarks
+

You may specify the static value in this property. Note: if the Expression +property is not empty, it will be calculated and its value will be returned.

+

Implements

IFRSerializable diff --git a/ClassReference/api/FastReport.Data.BOConverterFlags.html b/ClassReference/api/FastReport.Data.BOConverterFlags.html index ddec739..df55161 100644 --- a/ClassReference/api/FastReport.Data.BOConverterFlags.html +++ b/ClassReference/api/FastReport.Data.BOConverterFlags.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Data.BusinessObjectDataSource.html b/ClassReference/api/FastReport.Data.BusinessObjectDataSource.html index 0a71137..a48fd5f 100644 --- a/ClassReference/api/FastReport.Data.BusinessObjectDataSource.html +++ b/ClassReference/api/FastReport.Data.BusinessObjectDataSource.html @@ -10,7 +10,7 @@ - + @@ -92,6 +92,9 @@
Implements
Inherited Members
+ @@ -361,7 +364,8 @@

Methods

Deserialize(FRReader)

-
+

Deserializes the object.

+
Declaration
@@ -380,17 +384,29 @@
Parameters
FRReader reader - +

Reader 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 restore the state. It may + happen when:

+
  • loading the report from a file or stream;
  • loading the report from the designer's undo + buffer;
  • assigning another object to this object using the +Assign(Base) or AssignAll(Base) methods;
  • loading the object from the designer's + clipboard;
+

GetValue(Column)

-
+

Gets data stored in a specified column.

+
Declaration
@@ -409,7 +425,8 @@
Parameters
Column column - +

The column.

+ @@ -424,7 +441,8 @@
Returns
System.Object - +

An object that contains the data.

+ @@ -434,7 +452,8 @@
Overrides

GetValue(String)

-
+

Gets data stored in a specified column.

+
Declaration
@@ -453,7 +472,8 @@
Parameters
System.String alias - +

The column alias.

+ @@ -468,7 +488,8 @@
Returns
System.Object - +

An object that contains the data.

+ @@ -478,7 +499,8 @@
Overrides

InitSchema()

-
+

Initializes the datasource schema.

+
Declaration
@@ -486,11 +508,15 @@
Declaration
Overrides
+
Remarks
+

This method is used to support the FastReport.Net infrastructure. Do not call it directly.

+

LoadData(ArrayList)

-
+

Loads the datasource with data.

+
Declaration
@@ -509,12 +535,16 @@
Parameters
System.Collections.ArrayList rows - +

Rows to fill with data.

+
Overrides
+
Remarks
+

This method is used to support the FastReport.Net infrastructure. Do not call it directly.

+

Events

diff --git a/ClassReference/api/FastReport.Data.Column.html b/ClassReference/api/FastReport.Data.Column.html index 9036890..17d348d 100644 --- a/ClassReference/api/FastReport.Data.Column.html +++ b/ClassReference/api/FastReport.Data.Column.html @@ -10,7 +10,7 @@ - + @@ -518,7 +518,8 @@

Methods

AddChild(Base)

-
+

Adds a child object to this object's childs.

+
Declaration
@@ -537,7 +538,8 @@
Parameters
Base child - +

Object to add.

+ @@ -545,7 +547,8 @@
Parameters

CanContain(Base)

-
+

Gets a value indicating that this object can contain the specified child object.

+
Declaration
@@ -564,7 +567,8 @@
Parameters
Base child - +

Child object.

+ @@ -579,7 +583,8 @@
Returns
System.Boolean - +

true if this object can contain the specified child object; otherwise, false.

+ @@ -587,7 +592,8 @@
Returns

GetChildObjects(ObjectCollection)

-
+

Gets a list of child objects.

+
Declaration
@@ -606,7 +612,8 @@
Parameters
ObjectCollection list - +

List to fill with values.

+ @@ -614,7 +621,8 @@
Parameters

GetChildOrder(Base)

-
+

Returns z-order of the specified child object.

+
Declaration
@@ -633,7 +641,8 @@
Parameters
Base child - +

Child object.

+ @@ -648,15 +657,20 @@
Returns
System.Int32 - +

Z-order of the specified object.

+ +
Remarks
+

This method must return the index of a specified child object in the internal child list.

+

GetExpressions()

-
+

Gets all expressions contained in the object.

+
Declaration
@@ -673,17 +687,29 @@
Returns
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. +

+

RemoveChild(Base)

-
+

Removes a specified object from this object's childs.

+
Declaration
@@ -710,7 +736,8 @@
Parameters

Serialize(FRWriter)

-
+

Serializes the object.

+
Declaration
@@ -729,17 +756,30 @@
Parameters
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(Base) methods; +
  • saving the object to the designer's clipboard;
  • saving the object to the preview (when run a +report).
+

SetChildOrder(Base, Int32)

-
+

Sets the z-order of the specified object.

+
Declaration
@@ -758,20 +798,26 @@
Parameters
Base child - +

Child object.

+ System.Int32 order - +

New Z-order.

+ +
Remarks
+

This method must place the specified child object at the specified position in the internal child list.

+

SetName(String)

-
+

Sets the object's name.

+
Declaration
@@ -790,17 +836,27 @@
Parameters
System.String value - +

New name.

+
Overrides
+
Remarks
+

This method is for internal use only. It just sets a new name without any checks +(unlike the Name property setter).

+
+
See Also
+
+ +

UpdateLayout(Single, Single)

-
+

Updates the children layout when the size of this object is changed by dx, dy values.

+
Declaration
@@ -819,15 +875,21 @@
Parameters
System.Single dx - +

X delta.

+ System.Single dy - +

Y delta.

+ +
Remarks
+

This method must update positions/sizes of child objects whose Dock or Anchor properties +are set to non-default values.

+

Implements

IFRSerializable diff --git a/ClassReference/api/FastReport.Data.ColumnBindableControl.html b/ClassReference/api/FastReport.Data.ColumnBindableControl.html index 18b8824..e388f04 100644 --- a/ClassReference/api/FastReport.Data.ColumnBindableControl.html +++ b/ClassReference/api/FastReport.Data.ColumnBindableControl.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Data.ColumnCollection.html b/ClassReference/api/FastReport.Data.ColumnCollection.html index 8f86a18..47579b5 100644 --- a/ClassReference/api/FastReport.Data.ColumnCollection.html +++ b/ClassReference/api/FastReport.Data.ColumnCollection.html @@ -10,7 +10,7 @@ - + @@ -499,6 +499,17 @@
Returns
+ + + +

Sort()

+

Sorts the collection of columns.

+
+
+
Declaration
+
+
public void Sort()
+

Implements

System.Collections.IList diff --git a/ClassReference/api/FastReport.Data.ColumnComparer.html b/ClassReference/api/FastReport.Data.ColumnComparer.html new file mode 100644 index 0000000..574f7bb --- /dev/null +++ b/ClassReference/api/FastReport.Data.ColumnComparer.html @@ -0,0 +1,206 @@ + + + + + + + + Class ColumnComparer + | FastReport OpenSource Class Reference + + + + + + + + + + + + + + + +
+
+ + + + +
+ + + +
+ + + + + + diff --git a/ClassReference/api/FastReport.Data.ColumnFormat.html b/ClassReference/api/FastReport.Data.ColumnFormat.html index e02683c..ad5c379 100644 --- a/ClassReference/api/FastReport.Data.ColumnFormat.html +++ b/ClassReference/api/FastReport.Data.ColumnFormat.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Data.CommandParameter.html b/ClassReference/api/FastReport.Data.CommandParameter.html index d5b1d87..1b048f4 100644 --- a/ClassReference/api/FastReport.Data.CommandParameter.html +++ b/ClassReference/api/FastReport.Data.CommandParameter.html @@ -10,7 +10,7 @@ - + @@ -409,7 +409,8 @@

Methods

GetExpressions()

-
+

Gets all expressions contained in the object.

+
Declaration
@@ -426,17 +427,29 @@
Returns
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
@@ -455,12 +468,24 @@
Parameters
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(Base) methods; +
  • saving the object to the designer's clipboard;
  • saving the object to the preview (when run a +report).
+

Implements

IFRSerializable diff --git a/ClassReference/api/FastReport.Data.CommandParameterCollection.html b/ClassReference/api/FastReport.Data.CommandParameterCollection.html index 4cd225a..3b38232 100644 --- a/ClassReference/api/FastReport.Data.CommandParameterCollection.html +++ b/ClassReference/api/FastReport.Data.CommandParameterCollection.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Data.ConnectionCollection.html b/ClassReference/api/FastReport.Data.ConnectionCollection.html index 051835c..ae6347a 100644 --- a/ClassReference/api/FastReport.Data.ConnectionCollection.html +++ b/ClassReference/api/FastReport.Data.ConnectionCollection.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Data.CopyNameMacroVariable.html b/ClassReference/api/FastReport.Data.CopyNameMacroVariable.html index f3943e8..4d7bc58 100644 --- a/ClassReference/api/FastReport.Data.CopyNameMacroVariable.html +++ b/ClassReference/api/FastReport.Data.CopyNameMacroVariable.html @@ -10,7 +10,7 @@ - + @@ -280,7 +280,8 @@

Properties

Value

-
+

Gets or sets the value of parameter.

+
Declaration
@@ -303,6 +304,10 @@
Property Value
Overrides
+
Remarks
+

You may specify the static value in this property. Note: if the Expression +property is not empty, it will be calculated and its value will be returned.

+

Implements

IFRSerializable diff --git a/ClassReference/api/FastReport.Data.CsvConnectionStringBuilder.html b/ClassReference/api/FastReport.Data.CsvConnectionStringBuilder.html index 5ac1ebf..e471ca3 100644 --- a/ClassReference/api/FastReport.Data.CsvConnectionStringBuilder.html +++ b/ClassReference/api/FastReport.Data.CsvConnectionStringBuilder.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Data.CsvDataConnection.html b/ClassReference/api/FastReport.Data.CsvDataConnection.html index 7613a2b..aae929b 100644 --- a/ClassReference/api/FastReport.Data.CsvDataConnection.html +++ b/ClassReference/api/FastReport.Data.CsvDataConnection.html @@ -10,7 +10,7 @@ - + @@ -541,7 +541,8 @@

Methods

CreateDataSet()

-
+

Initializes a DataSet instance.

+
Declaration
@@ -558,17 +559,23 @@
Returns
DataSet - +

The DataSet object.

+
Overrides
+
Remarks
+

This method is used to support FastReport infrastructure. You don't need to use it.

+

CreateTable(TableDataSource)

-
+

Creates table. +For internal use only.

+
Declaration
@@ -597,7 +604,9 @@
Overrides

DeleteTable(TableDataSource)

-
+

Deletes table. +For internal use only.

+
Declaration
@@ -626,7 +635,8 @@
Overrides

FillTableData(DataTable, String, CommandParameterCollection)

-
+

Fills the table data.

+
Declaration
@@ -645,27 +655,36 @@
Parameters
DataTable table - +

DataTable to fill.

+ System.String selectCommand - +

The SQL select command.

+ CommandParameterCollection parameters - +

SQL parameters.

+
Overrides
+
Remarks
+

Usually you don't need to use this method. Internally it uses the GetConnection() and +GetAdapter(String, DbConnection, CommandParameterCollection) methods to fill the table data. If you create own connection component +that does not use nor connection or adapter, then you need to override this method.

+

FillTableSchema(DataTable, String, CommandParameterCollection)

-
+

Fills the table schema.

+
Declaration
@@ -684,27 +703,36 @@
Parameters
DataTable table - +

DataTable to fill.

+ System.String selectCommand - +

The SQL select command.

+ CommandParameterCollection parameters - +

SQL parameters.

+
Overrides
+
Remarks
+

Usually you don't need to use this method. Internally it uses the GetConnection() and +GetAdapter(String, DbConnection, CommandParameterCollection) methods to fill the table schema. If you create own connection component +that does not use nor connection or adapter, then you need to override this method.

+

QuoteIdentifier(String, DbConnection)

-
+

Quotes the specified DB identifier such as table name or column name.

+
Declaration
@@ -723,12 +751,14 @@
Parameters
System.String value - +

Identifier to quote.

+ DbConnection connection - +

The opened DB connection.

+ @@ -743,7 +773,8 @@
Returns
System.String - +

The quoted identifier.

+ @@ -753,7 +784,8 @@
Overrides

SetConnectionString(String)

-
+

Sets the connection string.

+
Declaration
@@ -772,12 +804,16 @@
Parameters
System.String value - +

New connection string.

+
Overrides
+
Remarks
+

Use this method if you need to perform some actions when the connection string is set.

+

Implements

IFRSerializable diff --git a/ClassReference/api/FastReport.Data.CubeSourceBase.html b/ClassReference/api/FastReport.Data.CubeSourceBase.html index 203ee8e..7d789bc 100644 --- a/ClassReference/api/FastReport.Data.CubeSourceBase.html +++ b/ClassReference/api/FastReport.Data.CubeSourceBase.html @@ -10,7 +10,7 @@ - + @@ -525,7 +525,8 @@
Declaration

Deserialize(FRReader)

-
+

Deserializes the object.

+
Declaration
@@ -544,12 +545,23 @@
Parameters
FRReader reader - +

Reader 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 restore the state. It may + happen when:

+
  • loading the report from a file or stream;
  • loading the report from the designer's undo + buffer;
  • assigning another object to this object using the +Assign(Base) or AssignAll(Base) methods;
  • loading the object from the designer's + clipboard;
+
@@ -727,7 +739,8 @@
Returns

Serialize(FRWriter)

-
+

Serializes the object.

+
Declaration
@@ -746,12 +759,24 @@
Parameters
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(Base) methods; +
  • saving the object to the designer's clipboard;
  • saving the object to the preview (when run a +report).
+
diff --git a/ClassReference/api/FastReport.Data.CubeSourceCollection.html b/ClassReference/api/FastReport.Data.CubeSourceCollection.html index c4156a6..c882765 100644 --- a/ClassReference/api/FastReport.Data.CubeSourceCollection.html +++ b/ClassReference/api/FastReport.Data.CubeSourceCollection.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Data.DataComponentBase.html b/ClassReference/api/FastReport.Data.DataComponentBase.html index 406a76b..ade8ee9 100644 --- a/ClassReference/api/FastReport.Data.DataComponentBase.html +++ b/ClassReference/api/FastReport.Data.DataComponentBase.html @@ -10,7 +10,7 @@ - + @@ -390,7 +390,8 @@

Methods

Assign(Base)

-
+

Copies the contents of another, similar object.

+
Declaration
@@ -409,12 +410,28 @@
Parameters
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(Base) method. +

+
+
See Also
+ @@ -433,7 +450,8 @@
Remarks

Serialize(FRWriter)

-
+

Serializes the object.

+
Declaration
@@ -452,17 +470,30 @@
Parameters
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(Base) methods; +
  • saving the object to the designer's clipboard;
  • saving the object to the preview (when run a +report).
+

SetName(String)

-
+

Sets the object's name.

+
Declaration
@@ -481,12 +512,21 @@
Parameters
System.String value - +

New name.

+
Overrides
+
Remarks
+

This method is for internal use only. It just sets a new name without any checks +(unlike the Name property setter).

+
+
See Also
+
+ +

Implements

IFRSerializable diff --git a/ClassReference/api/FastReport.Data.DataConnectionBase.html b/ClassReference/api/FastReport.Data.DataConnectionBase.html index 761edf6..a350534 100644 --- a/ClassReference/api/FastReport.Data.DataConnectionBase.html +++ b/ClassReference/api/FastReport.Data.DataConnectionBase.html @@ -10,7 +10,7 @@ - + @@ -83,6 +83,7 @@
Inheritance
DataConnectionBase
+
@@ -496,7 +497,8 @@

Methods

AddChild(Base)

-
+

Adds a child object to this object's childs.

+
Declaration
@@ -515,7 +517,8 @@
Parameters
Base child - +

Object to add.

+ @@ -523,7 +526,8 @@
Parameters

CanContain(Base)

-
+

Gets a value indicating that this object can contain the specified child object.

+
Declaration
@@ -542,7 +546,8 @@
Parameters
Base child - +

Child object.

+ @@ -557,7 +562,8 @@
Returns
System.Boolean - +

true if this object can contain the specified child object; otherwise, false.

+ @@ -585,7 +591,7 @@

Declaration
-
public void CreateAllTables(bool initSchema)
+
public virtual void CreateAllTables(bool initSchema)
Parameters
@@ -644,7 +650,7 @@

Declaration
-
public void CreateRelations()
+
public virtual void CreateRelations()
@@ -949,7 +955,8 @@

GetChildObjects(ObjectCollection)

-
+

Gets a list of child objects.

+
Declaration
@@ -968,7 +975,8 @@
Parameters
- +
ObjectCollection list

List to fill with values.

+
@@ -976,7 +984,8 @@
Parameters

GetChildOrder(Base)

-
+

Returns z-order of the specified child object.

+
Declaration
@@ -995,7 +1004,8 @@
Parameters
Base child - +

Child object.

+ @@ -1010,10 +1020,14 @@
Returns
System.Int32 - +

Z-order of the specified object.

+ +
Remarks
+

This method must return the index of a specified child object in the internal child list.

+
@@ -1144,7 +1158,8 @@
Examples<

GetExpressions()

-
+

Gets all expressions contained in the object.

+
Declaration
@@ -1161,12 +1176,23 @@
Returns
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. +

+
@@ -1315,7 +1341,8 @@
Returns

RemoveChild(Base)

-
+

Removes a specified object from this object's childs.

+
Declaration
@@ -1342,7 +1369,8 @@
Parameters

Serialize(FRWriter)

-
+

Serializes the object.

+
Declaration
@@ -1361,17 +1389,30 @@
Parameters
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(Base) methods; +
  • saving the object to the designer's clipboard;
  • saving the object to the preview (when run a +report).
+

SetChildOrder(Base, Int32)

-
+

Sets the z-order of the specified object.

+
Declaration
@@ -1390,15 +1431,20 @@
Parameters
Base child - +

Child object.

+ System.Int32 order - +

New Z-order.

+ +
Remarks
+

This method must place the specified child object at the specified position in the internal child list.

+
@@ -1435,7 +1481,8 @@

UpdateLayout(Single, Single)

-
+

Updates the children layout when the size of this object is changed by dx, dy values.

+
Declaration
@@ -1454,15 +1501,21 @@
Parameters
System.Single dx - +

X delta.

+ System.Single dy - +

Y delta.

+ +
Remarks
+

This method must update positions/sizes of child objects whose Dock or Anchor properties +are set to non-default values.

+

Implements

IFRSerializable diff --git a/ClassReference/api/FastReport.Data.DataSourceBase.html b/ClassReference/api/FastReport.Data.DataSourceBase.html index bfe43b9..6c000d2 100644 --- a/ClassReference/api/FastReport.Data.DataSourceBase.html +++ b/ClassReference/api/FastReport.Data.DataSourceBase.html @@ -10,7 +10,7 @@ - + @@ -288,6 +288,32 @@
Declaration
public DataSourceBase()
+

Fields +

+ + +

currentRow

+
+
+
Declaration
+
+
protected object currentRow
+
+
Field Value
+ + + + + + + + + + + + + +
TypeDescription
System.Object

Properties

@@ -703,7 +729,8 @@

Methods

Deserialize(FRReader)

-
+

Deserializes the object.

+
Declaration
@@ -722,12 +749,23 @@
Parameters
FRReader reader - +

Reader 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 restore the state. It may + happen when:

+
  • loading the report from a file or stream;
  • loading the report from the designer's undo + buffer;
  • assigning another object to this object using the +Assign(Base) or AssignAll(Base) methods;
  • loading the object from the designer's + clipboard;
+
@@ -1052,7 +1090,8 @@
Parameters

InitializeComponent()

-
+

Initializes the object before running a report.

+
Declaration
@@ -1060,6 +1099,9 @@
Declaration
Overrides
+
Remarks
+

This method is used by the report engine, do not call it directly.

+
@@ -1138,7 +1180,8 @@
Remarks

Serialize(FRWriter)

-
+

Serializes the object.

+
Declaration
@@ -1157,12 +1200,24 @@
Parameters
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(Base) methods; +
  • saving the object to the designer's clipboard;
  • saving the object to the preview (when run a +report).
+

Events

diff --git a/ClassReference/api/FastReport.Data.DataSourceCollection.html b/ClassReference/api/FastReport.Data.DataSourceCollection.html index 24fb6e3..8ff2456 100644 --- a/ClassReference/api/FastReport.Data.DataSourceCollection.html +++ b/ClassReference/api/FastReport.Data.DataSourceCollection.html @@ -10,7 +10,7 @@ - + @@ -409,6 +409,17 @@
Returns
+ + + +

Sort()

+

Sorts data sources by theirs names.

+
+
+
Declaration
+
+
public void Sort()
+

Implements

System.Collections.IList diff --git a/ClassReference/api/FastReport.Data.DataSourceComparer.html b/ClassReference/api/FastReport.Data.DataSourceComparer.html new file mode 100644 index 0000000..83f3a5c --- /dev/null +++ b/ClassReference/api/FastReport.Data.DataSourceComparer.html @@ -0,0 +1,206 @@ + + + + + + + + Class DataSourceComparer + | FastReport OpenSource Class Reference + + + + + + + + + + + + + + + +
+
+ + + + +
+ + + +
+ + + + + + diff --git a/ClassReference/api/FastReport.Data.DateVariable.html b/ClassReference/api/FastReport.Data.DateVariable.html index 6aa2117..189d7ae 100644 --- a/ClassReference/api/FastReport.Data.DateVariable.html +++ b/ClassReference/api/FastReport.Data.DateVariable.html @@ -10,7 +10,7 @@ - + @@ -278,7 +278,8 @@

Properties

Value

-
+

Gets or sets the value of parameter.

+
Declaration
@@ -301,6 +302,10 @@
Property Value
Overrides
+
Remarks
+

You may specify the static value in this property. Note: if the Expression +property is not empty, it will be calculated and its value will be returned.

+

Implements

IFRSerializable diff --git a/ClassReference/api/FastReport.Data.Dictionary.RegDataItem.html b/ClassReference/api/FastReport.Data.Dictionary.RegDataItem.html index 5bb4f5e..b9b2d21 100644 --- a/ClassReference/api/FastReport.Data.Dictionary.RegDataItem.html +++ b/ClassReference/api/FastReport.Data.Dictionary.RegDataItem.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Data.Dictionary.html b/ClassReference/api/FastReport.Data.Dictionary.html index 1367274..e96b930 100644 --- a/ClassReference/api/FastReport.Data.Dictionary.html +++ b/ClassReference/api/FastReport.Data.Dictionary.html @@ -10,7 +10,7 @@ - + @@ -478,7 +478,8 @@

Methods

AddChild(Base)

-
+

Adds a child object to this object's childs.

+
Declaration
@@ -497,7 +498,8 @@
Parameters
Base child - +

Object to add.

+ @@ -505,7 +507,8 @@
Parameters

Assign(Base)

-
+

Copies the contents of another, similar object.

+
Declaration
@@ -524,17 +527,34 @@
Parameters
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(Base) method. +

+
+
See Also
+

CanContain(Base)

-
+

Gets a value indicating that this object can contain the specified child object.

+
Declaration
@@ -553,7 +573,8 @@
Parameters
Base child - +

Child object.

+ @@ -568,7 +589,8 @@
Returns
System.Boolean - +

true if this object can contain the specified child object; otherwise, false.

+ @@ -700,7 +722,8 @@
Rema

Deserialize(FRReader)

-
+

Deserializes the object.

+
Declaration
@@ -719,12 +742,23 @@
Parameters
FRReader reader - +

Reader 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 restore the state. It may + happen when:

+
  • loading the report from a file or stream;
  • loading the report from the designer's undo + buffer;
  • assigning another object to this object using the +Assign(Base) or AssignAll(Base) methods;
  • loading the object from the designer's + clipboard;
+
@@ -915,7 +949,8 @@
Remar

GetChildObjects(ObjectCollection)

-
+

Gets a list of child objects.

+
Declaration
@@ -934,7 +969,8 @@
Parameters
ObjectCollection list - +

List to fill with values.

+ @@ -942,7 +978,8 @@
Parameters

GetChildOrder(Base)

-
+

Returns z-order of the specified child object.

+
Declaration
@@ -961,7 +998,8 @@
Parameters
Base child - +

Child object.

+ @@ -976,10 +1014,14 @@
Returns
System.Int32 - +

Z-order of the specified object.

+ +
Remarks
+

This method must return the index of a specified child object in the internal child list.

+
@@ -1253,7 +1295,8 @@

RemoveChild(Base)

-
+

Removes a specified object from this object's childs.

+
Declaration
@@ -1380,7 +1423,8 @@
Parameters

Serialize(FRWriter)

-
+

Serializes the object.

+
Declaration
@@ -1399,17 +1443,30 @@
Parameters
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(Base) methods; +
  • saving the object to the designer's clipboard;
  • saving the object to the preview (when run a +report).
+

SetChildOrder(Base, Int32)

-
+

Sets the z-order of the specified object.

+
Declaration
@@ -1428,15 +1485,20 @@
Parameters
Base child - +

Child object.

+ System.Int32 order - +

New Z-order.

+ +
Remarks
+

This method must place the specified child object at the specified position in the internal child list.

+
@@ -1508,7 +1570,8 @@

UpdateLayout(Single, Single)

-
+

Updates the children layout when the size of this object is changed by dx, dy values.

+
Declaration
@@ -1527,15 +1590,21 @@
Parameters
System.Single dx - +

X delta.

+ System.Single dy - +

Y delta.

+ +
Remarks
+

This method must update positions/sizes of child objects whose Dock or Anchor properties +are set to non-default values.

+
diff --git a/ClassReference/api/FastReport.Data.FilterOperation.html b/ClassReference/api/FastReport.Data.FilterOperation.html index 4be80f2..eee5d2e 100644 --- a/ClassReference/api/FastReport.Data.FilterOperation.html +++ b/ClassReference/api/FastReport.Data.FilterOperation.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Data.HierarchyLevelVariable.html b/ClassReference/api/FastReport.Data.HierarchyLevelVariable.html index c5ef1c4..8c22cb9 100644 --- a/ClassReference/api/FastReport.Data.HierarchyLevelVariable.html +++ b/ClassReference/api/FastReport.Data.HierarchyLevelVariable.html @@ -10,7 +10,7 @@ - + @@ -278,7 +278,8 @@

Properties

Value

-
+

Gets or sets the value of parameter.

+
Declaration
@@ -301,6 +302,10 @@
Property Value
Overrides
+
Remarks
+

You may specify the static value in this property. Note: if the Expression +property is not empty, it will be calculated and its value will be returned.

+

Implements

IFRSerializable diff --git a/ClassReference/api/FastReport.Data.HierarchyRowNoVariable.html b/ClassReference/api/FastReport.Data.HierarchyRowNoVariable.html index cca6d68..f613bcf 100644 --- a/ClassReference/api/FastReport.Data.HierarchyRowNoVariable.html +++ b/ClassReference/api/FastReport.Data.HierarchyRowNoVariable.html @@ -10,7 +10,7 @@ - + @@ -278,7 +278,8 @@

Properties

Value

-
+

Gets or sets the value of parameter.

+
Declaration
@@ -301,6 +302,10 @@
Property Value
Overrides
+
Remarks
+

You may specify the static value in this property. Note: if the Expression +property is not empty, it will be calculated and its value will be returned.

+

Implements

IFRSerializable diff --git a/ClassReference/api/FastReport.Data.JsonConnection.JsonDataSourceConnection.html b/ClassReference/api/FastReport.Data.JsonConnection.JsonDataSourceConnection.html new file mode 100644 index 0000000..42cf4a1 --- /dev/null +++ b/ClassReference/api/FastReport.Data.JsonConnection.JsonDataSourceConnection.html @@ -0,0 +1,757 @@ + + + + + + + + Class JsonDataSourceConnection + | FastReport OpenSource Class Reference + + + + + + + + + + + + + + + +
+
+ + + + +
+ + + +
+ + + + + + diff --git a/ClassReference/api/FastReport.Data.JsonConnection.JsonDataSourceConnectionStringBuilder.html b/ClassReference/api/FastReport.Data.JsonConnection.JsonDataSourceConnectionStringBuilder.html new file mode 100644 index 0000000..9d79d83 --- /dev/null +++ b/ClassReference/api/FastReport.Data.JsonConnection.JsonDataSourceConnectionStringBuilder.html @@ -0,0 +1,251 @@ + + + + + + + + Class JsonDataSourceConnectionStringBuilder + | FastReport OpenSource Class Reference + + + + + + + + + + + + + + + +
+
+ + + + +
+ + + +
+ + + + + + diff --git a/ClassReference/api/FastReport.Data.JsonConnection.JsonTableDataSource.html b/ClassReference/api/FastReport.Data.JsonConnection.JsonTableDataSource.html new file mode 100644 index 0000000..231ce71 --- /dev/null +++ b/ClassReference/api/FastReport.Data.JsonConnection.JsonTableDataSource.html @@ -0,0 +1,629 @@ + + + + + + + + Class JsonTableDataSource + | FastReport OpenSource Class Reference + + + + + + + + + + + + + + + +
+
+ + + + +
+ + + +
+ + + + + + diff --git a/ClassReference/api/FastReport.Data.JsonConnection.html b/ClassReference/api/FastReport.Data.JsonConnection.html new file mode 100644 index 0000000..d8aa0e0 --- /dev/null +++ b/ClassReference/api/FastReport.Data.JsonConnection.html @@ -0,0 +1,124 @@ + + + + + + + + Namespace FastReport.Data.JsonConnection + | FastReport OpenSource Class Reference + + + + + + + + + + + + + + + +
+
+ + + + +
+ + + +
+ + + + + + diff --git a/ClassReference/api/FastReport.Data.LoadBusinessObjectEventArgs.html b/ClassReference/api/FastReport.Data.LoadBusinessObjectEventArgs.html index 52ba9c0..3816aaa 100644 --- a/ClassReference/api/FastReport.Data.LoadBusinessObjectEventArgs.html +++ b/ClassReference/api/FastReport.Data.LoadBusinessObjectEventArgs.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Data.LoadBusinessObjectEventHandler.html b/ClassReference/api/FastReport.Data.LoadBusinessObjectEventHandler.html index d95cfaf..34ba8e8 100644 --- a/ClassReference/api/FastReport.Data.LoadBusinessObjectEventHandler.html +++ b/ClassReference/api/FastReport.Data.LoadBusinessObjectEventHandler.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Data.PageMacroVariable.html b/ClassReference/api/FastReport.Data.PageMacroVariable.html index a633b03..b861f2a 100644 --- a/ClassReference/api/FastReport.Data.PageMacroVariable.html +++ b/ClassReference/api/FastReport.Data.PageMacroVariable.html @@ -10,7 +10,7 @@ - + @@ -280,7 +280,8 @@

Properties

Value

-
+

Gets or sets the value of parameter.

+
Declaration
@@ -303,6 +304,10 @@
Property Value
Overrides
+
Remarks
+

You may specify the static value in this property. Note: if the Expression +property is not empty, it will be calculated and its value will be returned.

+

Implements

IFRSerializable diff --git a/ClassReference/api/FastReport.Data.PageNVariable.html b/ClassReference/api/FastReport.Data.PageNVariable.html index 5293085..467fe0f 100644 --- a/ClassReference/api/FastReport.Data.PageNVariable.html +++ b/ClassReference/api/FastReport.Data.PageNVariable.html @@ -10,7 +10,7 @@ - + @@ -278,7 +278,8 @@

Properties

Value

-
+

Gets or sets the value of parameter.

+
Declaration
@@ -301,6 +302,10 @@
Property Value
Overrides
+
Remarks
+

You may specify the static value in this property. Note: if the Expression +property is not empty, it will be calculated and its value will be returned.

+

Implements

IFRSerializable diff --git a/ClassReference/api/FastReport.Data.PageNofMVariable.html b/ClassReference/api/FastReport.Data.PageNofMVariable.html index 4a720de..a57e816 100644 --- a/ClassReference/api/FastReport.Data.PageNofMVariable.html +++ b/ClassReference/api/FastReport.Data.PageNofMVariable.html @@ -10,7 +10,7 @@ - + @@ -279,7 +279,8 @@

Properties

Value

-
+

Gets or sets the value of parameter.

+
Declaration
@@ -302,6 +303,10 @@
Property Value
Overrides
+
Remarks
+

You may specify the static value in this property. Note: if the Expression +property is not empty, it will be calculated and its value will be returned.

+

Implements

IFRSerializable diff --git a/ClassReference/api/FastReport.Data.PageVariable.html b/ClassReference/api/FastReport.Data.PageVariable.html index ede19c8..82f6dfa 100644 --- a/ClassReference/api/FastReport.Data.PageVariable.html +++ b/ClassReference/api/FastReport.Data.PageVariable.html @@ -10,7 +10,7 @@ - + @@ -278,7 +278,8 @@

Properties

Value

-
+

Gets or sets the value of parameter.

+
Declaration
@@ -301,6 +302,10 @@
Property Value
Overrides
+
Remarks
+

You may specify the static value in this property. Note: if the Expression +property is not empty, it will be calculated and its value will be returned.

+

Implements

IFRSerializable diff --git a/ClassReference/api/FastReport.Data.Parameter.html b/ClassReference/api/FastReport.Data.Parameter.html index e7e38d6..58f2cd3 100644 --- a/ClassReference/api/FastReport.Data.Parameter.html +++ b/ClassReference/api/FastReport.Data.Parameter.html @@ -10,7 +10,7 @@ - + @@ -514,7 +514,8 @@

Methods

AddChild(Base)

-
+

Adds a child object to this object's childs.

+
Declaration
@@ -533,7 +534,8 @@
Parameters
Base child - +

Object to add.

+ @@ -541,7 +543,8 @@
Parameters

Assign(Base)

-
+

Copies the contents of another, similar object.

+
Declaration
@@ -560,17 +563,34 @@
Parameters
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(Base) method. +

+
+
See Also
+

CanContain(Base)

-
+

Gets a value indicating that this object can contain the specified child object.

+
Declaration
@@ -589,7 +609,8 @@
Parameters
Base child - +

Child object.

+ @@ -604,7 +625,8 @@
Returns
System.Boolean - +

true if this object can contain the specified child object; otherwise, false.

+ @@ -612,7 +634,8 @@
Returns

GetChildObjects(ObjectCollection)

-
+

Gets a list of child objects.

+
Declaration
@@ -631,7 +654,8 @@
Parameters
ObjectCollection list - +

List to fill with values.

+ @@ -639,7 +663,8 @@
Parameters

GetChildOrder(Base)

-
+

Returns z-order of the specified child object.

+
Declaration
@@ -658,7 +683,8 @@
Parameters
Base child - +

Child object.

+ @@ -673,15 +699,20 @@
Returns
System.Int32 - +

Z-order of the specified object.

+ +
Remarks
+

This method must return the index of a specified child object in the internal child list.

+

GetExpressions()

-
+

Gets all expressions contained in the object.

+
Declaration
@@ -698,17 +729,29 @@
Returns
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. +

+

RemoveChild(Base)

-
+

Removes a specified object from this object's childs.

+
Declaration
@@ -735,7 +778,8 @@
Parameters

Serialize(FRWriter)

-
+

Serializes the object.

+
Declaration
@@ -754,17 +798,30 @@
Parameters
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(Base) methods; +
  • saving the object to the designer's clipboard;
  • saving the object to the preview (when run a +report).
+

SetChildOrder(Base, Int32)

-
+

Sets the z-order of the specified object.

+
Declaration
@@ -783,20 +840,26 @@
Parameters
Base child - +

Child object.

+ System.Int32 order - +

New Z-order.

+ +
Remarks
+

This method must place the specified child object at the specified position in the internal child list.

+

UpdateLayout(Single, Single)

-
+

Updates the children layout when the size of this object is changed by dx, dy values.

+
Declaration
@@ -815,15 +878,21 @@
Parameters
System.Single dx - +

X delta.

+ System.Single dy - +

Y delta.

+ +
Remarks
+

This method must update positions/sizes of child objects whose Dock or Anchor properties +are set to non-default values.

+

Implements

IFRSerializable diff --git a/ClassReference/api/FastReport.Data.ParameterCollection.html b/ClassReference/api/FastReport.Data.ParameterCollection.html index 0bdb76a..c7d047a 100644 --- a/ClassReference/api/FastReport.Data.ParameterCollection.html +++ b/ClassReference/api/FastReport.Data.ParameterCollection.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Data.PropertyKind.html b/ClassReference/api/FastReport.Data.PropertyKind.html index 56cddcb..7601fb3 100644 --- a/ClassReference/api/FastReport.Data.PropertyKind.html +++ b/ClassReference/api/FastReport.Data.PropertyKind.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Data.Relation.html b/ClassReference/api/FastReport.Data.Relation.html index 6b79f20..b0613b7 100644 --- a/ClassReference/api/FastReport.Data.Relation.html +++ b/ClassReference/api/FastReport.Data.Relation.html @@ -10,7 +10,7 @@ - + @@ -441,7 +441,8 @@
Returns

Serialize(FRWriter)

-
+

Serializes the object.

+
Declaration
@@ -460,12 +461,24 @@
Parameters
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(Base) methods; +
  • saving the object to the designer's clipboard;
  • saving the object to the preview (when run a +report).
+

Implements

IFRSerializable diff --git a/ClassReference/api/FastReport.Data.RelationCollection.html b/ClassReference/api/FastReport.Data.RelationCollection.html index e2db518..46ac232 100644 --- a/ClassReference/api/FastReport.Data.RelationCollection.html +++ b/ClassReference/api/FastReport.Data.RelationCollection.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Data.RowVariable.html b/ClassReference/api/FastReport.Data.RowVariable.html index 4bde460..6f2135c 100644 --- a/ClassReference/api/FastReport.Data.RowVariable.html +++ b/ClassReference/api/FastReport.Data.RowVariable.html @@ -10,7 +10,7 @@ - + @@ -278,7 +278,8 @@

Properties

Value

-
+

Gets or sets the value of parameter.

+
Declaration
@@ -301,6 +302,10 @@
Property Value
Overrides
+
Remarks
+

You may specify the static value in this property. Note: if the Expression +property is not empty, it will be calculated and its value will be returned.

+

Implements

IFRSerializable diff --git a/ClassReference/api/FastReport.Data.SliceCubeSource.html b/ClassReference/api/FastReport.Data.SliceCubeSource.html index c8a5f0b..945f58e 100644 --- a/ClassReference/api/FastReport.Data.SliceCubeSource.html +++ b/ClassReference/api/FastReport.Data.SliceCubeSource.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Data.SystemVariable.html b/ClassReference/api/FastReport.Data.SystemVariable.html index 50e05ed..8764444 100644 --- a/ClassReference/api/FastReport.Data.SystemVariable.html +++ b/ClassReference/api/FastReport.Data.SystemVariable.html @@ -10,7 +10,7 @@ - + @@ -337,7 +337,8 @@

Methods

CanContain(Base)

-
+

Gets a value indicating that this object can contain the specified child object.

+
Declaration
@@ -356,7 +357,8 @@
Parameters
Base child - +

Child object.

+ @@ -371,7 +373,8 @@
Returns
System.Boolean - +

true if this object can contain the specified child object; otherwise, false.

+ diff --git a/ClassReference/api/FastReport.Data.SystemVariables.html b/ClassReference/api/FastReport.Data.SystemVariables.html index 6c4c495..eeece45 100644 --- a/ClassReference/api/FastReport.Data.SystemVariables.html +++ b/ClassReference/api/FastReport.Data.SystemVariables.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Data.TableCollection.html b/ClassReference/api/FastReport.Data.TableCollection.html index 5584e3d..b98c2f0 100644 --- a/ClassReference/api/FastReport.Data.TableCollection.html +++ b/ClassReference/api/FastReport.Data.TableCollection.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Data.TableDataSource.html b/ClassReference/api/FastReport.Data.TableDataSource.html index 5e50165..9665bea 100644 --- a/ClassReference/api/FastReport.Data.TableDataSource.html +++ b/ClassReference/api/FastReport.Data.TableDataSource.html @@ -10,7 +10,7 @@ - + @@ -84,6 +84,7 @@
Inheritance
TableDataSource
+
Implements
@@ -92,6 +93,9 @@
Implements
Inherited Members
+ @@ -596,7 +600,8 @@

Methods

AddChild(Base)

-
+

Adds a child object to this object's childs.

+
Declaration
@@ -615,7 +620,8 @@
Parameters
Base child - +

Object to add.

+ @@ -625,7 +631,8 @@
Overrides

CanContain(Base)

-
+

Gets a value indicating that this object can contain the specified child object.

+
Declaration
@@ -644,7 +651,8 @@
Parameters
Base child - +

Child object.

+ @@ -659,7 +667,8 @@
Returns
System.Boolean - +

true if this object can contain the specified child object; otherwise, false.

+ @@ -698,7 +707,8 @@
Overrides

GetChildObjects(ObjectCollection)

-
+

Gets a list of child objects.

+
Declaration
@@ -717,7 +727,8 @@
Parameters
ObjectCollection list - +

List to fill with values.

+ @@ -727,7 +738,8 @@
Overrides

GetValue(Column)

-
+

Gets data stored in a specified column.

+
Declaration
@@ -746,7 +758,8 @@
Parameters
Column column - +

The column.

+ @@ -761,7 +774,8 @@
Returns
System.Object - +

An object that contains the data.

+ @@ -771,7 +785,8 @@
Overrides

InitializeComponent()

-
+

Initializes the object before running a report.

+
Declaration
@@ -779,11 +794,15 @@
Declaration
Overrides
+
Remarks
+

This method is used by the report engine, do not call it directly.

+

InitSchema()

-
+

Initializes the datasource schema.

+
Declaration
@@ -791,11 +810,15 @@
Declaration
Overrides
+
Remarks
+

This method is used to support the FastReport.Net infrastructure. Do not call it directly.

+

LoadData(ArrayList)

-
+

Loads the datasource with data.

+
Declaration
@@ -814,12 +837,16 @@
Parameters
System.Collections.ArrayList rows - +

Rows to fill with data.

+
Overrides
+
Remarks
+

This method is used to support the FastReport.Net infrastructure. Do not call it directly.

+
@@ -835,7 +862,8 @@
Declaration

RemoveChild(Base)

-
+

Removes a specified object from this object's childs.

+
Declaration
@@ -864,7 +892,8 @@
Overrides

Serialize(FRWriter)

-
+

Serializes the object.

+
Declaration
@@ -883,17 +912,30 @@
Parameters
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(Base) methods; +
  • saving the object to the designer's clipboard;
  • saving the object to the preview (when run a +report).
+

SetParent(Base)

-
+

Sets the object's parent.

+
Declaration
@@ -912,12 +954,34 @@
Parameters
Base value - +

New parent.

+
Overrides
+
Remarks
+

This method is for internal use only. You can use it if you are developing a new +component for FastReport. Override it to perform some actions when the parent of an +object is changing. This method checks that parent can contain a child.

+
+
Exceptions
+ + + + + + + + + + + + + +
TypeCondition
ParentException

Parent object cannot contain this object.

+

Implements

IFRSerializable diff --git a/ClassReference/api/FastReport.Data.Total.html b/ClassReference/api/FastReport.Data.Total.html index b4a917a..f907109 100644 --- a/ClassReference/api/FastReport.Data.Total.html +++ b/ClassReference/api/FastReport.Data.Total.html @@ -10,7 +10,7 @@ - + @@ -530,7 +530,8 @@

Methods

Assign(Base)

-
+

Copies the contents of another, similar object.

+
Declaration
@@ -549,17 +550,34 @@
Parameters
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(Base) method. +

+
+
See Also
+

Clear()

-
+

Clears the object's state.

+
Declaration
@@ -567,11 +585,15 @@
Declaration
Overrides
+
Remarks
+

This method also disposes all object's children.

+

GetExpressions()

-
+

Gets all expressions contained in the object.

+
Declaration
@@ -588,17 +610,29 @@
Returns
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
@@ -617,12 +651,24 @@
Parameters
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(Base) methods; +
  • saving the object to the designer's clipboard;
  • saving the object to the preview (when run a +report).
+

Implements

IFRSerializable diff --git a/ClassReference/api/FastReport.Data.TotalCollection.html b/ClassReference/api/FastReport.Data.TotalCollection.html index 4ddfcd9..131bdbd 100644 --- a/ClassReference/api/FastReport.Data.TotalCollection.html +++ b/ClassReference/api/FastReport.Data.TotalCollection.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Data.TotalPagesMacroVariable.html b/ClassReference/api/FastReport.Data.TotalPagesMacroVariable.html index d5be923..9bb1ed2 100644 --- a/ClassReference/api/FastReport.Data.TotalPagesMacroVariable.html +++ b/ClassReference/api/FastReport.Data.TotalPagesMacroVariable.html @@ -10,7 +10,7 @@ - + @@ -280,7 +280,8 @@

Properties

Value

-
+

Gets or sets the value of parameter.

+
Declaration
@@ -303,6 +304,10 @@
Property Value
Overrides
+
Remarks
+

You may specify the static value in this property. Note: if the Expression +property is not empty, it will be calculated and its value will be returned.

+

Implements

IFRSerializable diff --git a/ClassReference/api/FastReport.Data.TotalPagesVariable.html b/ClassReference/api/FastReport.Data.TotalPagesVariable.html index 24d5c6f..ae4588c 100644 --- a/ClassReference/api/FastReport.Data.TotalPagesVariable.html +++ b/ClassReference/api/FastReport.Data.TotalPagesVariable.html @@ -10,7 +10,7 @@ - + @@ -279,7 +279,8 @@

Properties

Value

-
+

Gets or sets the value of parameter.

+
Declaration
@@ -302,6 +303,10 @@
Property Value
Overrides
+
Remarks
+

You may specify the static value in this property. Note: if the Expression +property is not empty, it will be calculated and its value will be returned.

+

Implements

IFRSerializable diff --git a/ClassReference/api/FastReport.Data.TotalType.html b/ClassReference/api/FastReport.Data.TotalType.html index 07e6785..a2a81ac 100644 --- a/ClassReference/api/FastReport.Data.TotalType.html +++ b/ClassReference/api/FastReport.Data.TotalType.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Data.ViewDataSource.html b/ClassReference/api/FastReport.Data.ViewDataSource.html index a4ce03b..00ac361 100644 --- a/ClassReference/api/FastReport.Data.ViewDataSource.html +++ b/ClassReference/api/FastReport.Data.ViewDataSource.html @@ -10,7 +10,7 @@ - + @@ -92,6 +92,9 @@
Implements
Inherited Members
+ @@ -396,7 +399,8 @@

Methods

GetValue(Column)

-
+

Gets data stored in a specified column.

+
Declaration
@@ -415,7 +419,8 @@
Parameters
Column column - +

The column.

+ @@ -430,7 +435,8 @@
Returns
System.Object - +

An object that contains the data.

+ @@ -440,7 +446,8 @@
Overrides

InitSchema()

-
+

Initializes the datasource schema.

+
Declaration
@@ -448,11 +455,15 @@
Declaration
Overrides
+
Remarks
+

This method is used to support the FastReport.Net infrastructure. Do not call it directly.

+

LoadData(ArrayList)

-
+

Loads the datasource with data.

+
Declaration
@@ -471,12 +482,16 @@
Parameters
System.Collections.ArrayList rows - +

Rows to fill with data.

+
Overrides
+
Remarks
+

This method is used to support the FastReport.Net infrastructure. Do not call it directly.

+

Implements

IFRSerializable diff --git a/ClassReference/api/FastReport.Data.XmlConnectionStringBuilder.html b/ClassReference/api/FastReport.Data.XmlConnectionStringBuilder.html index 57aed38..5d5ef67 100644 --- a/ClassReference/api/FastReport.Data.XmlConnectionStringBuilder.html +++ b/ClassReference/api/FastReport.Data.XmlConnectionStringBuilder.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Data.XmlDataConnection.html b/ClassReference/api/FastReport.Data.XmlDataConnection.html index e4f3155..c1f3276 100644 --- a/ClassReference/api/FastReport.Data.XmlDataConnection.html +++ b/ClassReference/api/FastReport.Data.XmlDataConnection.html @@ -10,7 +10,7 @@ - + @@ -410,7 +410,8 @@

Methods

CreateDataSet()

-
+

Initializes a DataSet instance.

+
Declaration
@@ -427,17 +428,23 @@
Returns
DataSet - +

The DataSet object.

+
Overrides
+
Remarks
+

This method is used to support FastReport infrastructure. You don't need to use it.

+

CreateTable(TableDataSource)

-
+

Creates table. +For internal use only.

+
Declaration
@@ -466,7 +473,9 @@
Overrides

DeleteTable(TableDataSource)

-
+

Deletes table. +For internal use only.

+
Declaration
@@ -495,7 +504,8 @@
Overrides

FillTableData(DataTable, String, CommandParameterCollection)

-
+

Fills the table data.

+
Declaration
@@ -514,27 +524,36 @@
Parameters
DataTable table - +

DataTable to fill.

+ System.String selectCommand - +

The SQL select command.

+ CommandParameterCollection parameters - +

SQL parameters.

+
Overrides
+
Remarks
+

Usually you don't need to use this method. Internally it uses the GetConnection() and +GetAdapter(String, DbConnection, CommandParameterCollection) methods to fill the table data. If you create own connection component +that does not use nor connection or adapter, then you need to override this method.

+

FillTableSchema(DataTable, String, CommandParameterCollection)

-
+

Fills the table schema.

+
Declaration
@@ -553,27 +572,36 @@
Parameters
DataTable table - +

DataTable to fill.

+ System.String selectCommand - +

The SQL select command.

+ CommandParameterCollection parameters - +

SQL parameters.

+
Overrides
+
Remarks
+

Usually you don't need to use this method. Internally it uses the GetConnection() and +GetAdapter(String, DbConnection, CommandParameterCollection) methods to fill the table schema. If you create own connection component +that does not use nor connection or adapter, then you need to override this method.

+

QuoteIdentifier(String, DbConnection)

-
+

Quotes the specified DB identifier such as table name or column name.

+
Declaration
@@ -592,12 +620,14 @@
Parameters
System.String value - +

Identifier to quote.

+ DbConnection connection - +

The opened DB connection.

+ @@ -612,7 +642,8 @@
Returns
System.String - +

The quoted identifier.

+ @@ -622,7 +653,8 @@
Overrides

SetConnectionString(String)

-
+

Sets the connection string.

+
Declaration
@@ -641,12 +673,16 @@
Parameters
System.String value - +

New connection string.

+
Overrides
+
Remarks
+

Use this method if you need to perform some actions when the connection string is set.

+

Implements

IFRSerializable diff --git a/ClassReference/api/FastReport.Data.html b/ClassReference/api/FastReport.Data.html index 60e4338..766ca35 100644 --- a/ClassReference/api/FastReport.Data.html +++ b/ClassReference/api/FastReport.Data.html @@ -10,7 +10,7 @@ - + @@ -88,6 +88,9 @@

Column

ColumnCollection

Represents the collection of Column objects.

+
+

ColumnComparer

+

Represents the comparer class that used for sorting the collection of columns.

CommandParameter

This class represents a single parameter to use in the "select" command.

@@ -126,6 +129,9 @@

DataSourceBase

DataSourceCollection

Represents the collection of DataSourceBase objects.

+
+

DataSourceComparer

+

Represents the comparer class that used for sorting the collection of data sources.

DateVariable

Returns date and time of the report's start.

diff --git a/ClassReference/api/FastReport.DataBand.html b/ClassReference/api/FastReport.DataBand.html index c17a40a..1157aed 100644 --- a/ClassReference/api/FastReport.DataBand.html +++ b/ClassReference/api/FastReport.DataBand.html @@ -10,7 +10,7 @@ - + @@ -102,6 +102,9 @@
Inherited Members
+ @@ -192,9 +195,6 @@
Inherited Members
- @@ -306,6 +306,9 @@
Inherited Members
+ @@ -372,6 +375,9 @@
Inherited Members
+ @@ -459,9 +465,6 @@
Inherited Members
- @@ -1077,7 +1080,8 @@

Methods

AddChild(Base)

-
+

Adds a child object to this object's childs.

+
Declaration
@@ -1096,7 +1100,8 @@
Parameters
Base child - +

Object to add.

+ @@ -1106,7 +1111,8 @@
Overrides

Assign(Base)

-
+

Copies the contents of another, similar object.

+
Declaration
@@ -1125,17 +1131,34 @@
Parameters
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(Base) method. +

+
+
See Also
+

CanContain(Base)

-
+

Gets a value indicating that this object can contain the specified child object.

+
Declaration
@@ -1154,7 +1177,8 @@
Parameters
Base child - +

Child object.

+ @@ -1169,7 +1193,8 @@
Returns
System.Boolean - +

true if this object can contain the specified child object; otherwise, false.

+ @@ -1179,7 +1204,8 @@
Overrides

DeserializeSubItems(FRReader)

-
+

Deserializes nested object properties.

+
Declaration
@@ -1198,17 +1224,29 @@
Parameters
FRReader reader - +

Reader object.

+
Overrides
+
Remarks
+

Typically the object serializes all properties to the single xml item:

+
<TextObject Name="Text2" Left="18.9" Top="37.8" Width="283.5" Height="28.35"/>
+

Some objects like DataBand have child objects that serialized in subitems:

+
<DataBand Name="Data1" Top="163" Width="718.2" Height="18.9">
+  <TextObject Name="Text3" Left="18.9" Top="37.8" Width="283.5" Height="28.35"/>
+</DataBand>
+

To read such subitems, the DeserializeSubItems method is used. Base +implementation reads the child objects. You may override it to read some specific subitems.

+

GetChildObjects(ObjectCollection)

-
+

Gets a list of child objects.

+
Declaration
@@ -1227,7 +1265,8 @@
Parameters
ObjectCollection list - +

List to fill with values.

+ @@ -1237,7 +1276,8 @@
Overrides

GetChildOrder(Base)

-
+

Returns z-order of the specified child object.

+
Declaration
@@ -1256,7 +1296,8 @@
Parameters
Base child - +

Child object.

+ @@ -1271,17 +1312,22 @@
Returns
System.Int32 - +

Z-order of the specified object.

+
Overrides
+
Remarks
+

This method must return the index of a specified child object in the internal child list.

+

GetExpressions()

-
+

Gets all expressions contained in the object.

+
Declaration
@@ -1298,12 +1344,23 @@
Returns
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. +

+
@@ -1319,7 +1376,8 @@
Declaration

InitializeComponent()

-
+

Initializes the object before running a report.

+
Declaration
@@ -1327,11 +1385,15 @@
Declaration
Overrides
+
Remarks
+

This method is used by the report engine, do not call it directly.

+

RemoveChild(Base)

-
+

Removes a specified object from this object's childs.

+
Declaration
@@ -1360,7 +1422,8 @@
Overrides

Serialize(FRWriter)

-
+

Serializes the object.

+
Declaration
@@ -1379,17 +1442,30 @@
Parameters
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(Base) methods; +
  • saving the object to the designer's clipboard;
  • saving the object to the preview (when run a +report).
+

SetChildOrder(Base, Int32)

-
+

Sets the z-order of the specified object.

+
Declaration
@@ -1408,17 +1484,22 @@
Parameters
Base child - +

Child object.

+ System.Int32 order - +

New Z-order.

+
Overrides
+
Remarks
+

This method must place the specified child object at the specified position in the internal child list.

+

Implements

IFRSerializable diff --git a/ClassReference/api/FastReport.DataFooterBand.html b/ClassReference/api/FastReport.DataFooterBand.html index 2e889ca..5dd7363 100644 --- a/ClassReference/api/FastReport.DataFooterBand.html +++ b/ClassReference/api/FastReport.DataFooterBand.html @@ -10,7 +10,7 @@ - + @@ -115,6 +115,9 @@
Inherited Members
+ @@ -229,9 +232,6 @@
Inherited Members
- @@ -343,6 +343,9 @@
Inherited Members
+ @@ -409,6 +412,9 @@
Inherited Members
+ @@ -499,9 +505,6 @@
Inherited Members
- diff --git a/ClassReference/api/FastReport.DataHeaderBand.html b/ClassReference/api/FastReport.DataHeaderBand.html index 867e383..0eb853f 100644 --- a/ClassReference/api/FastReport.DataHeaderBand.html +++ b/ClassReference/api/FastReport.DataHeaderBand.html @@ -10,7 +10,7 @@ - + @@ -115,6 +115,9 @@
Inherited Members
+ @@ -229,9 +232,6 @@
Inherited Members
- @@ -343,6 +343,9 @@
Inherited Members
+ @@ -409,6 +412,9 @@
Inherited Members
+ @@ -499,9 +505,6 @@
Inherited Members
- diff --git a/ClassReference/api/FastReport.DatabaseLoginEventArgs.html b/ClassReference/api/FastReport.DatabaseLoginEventArgs.html index 882e563..057866a 100644 --- a/ClassReference/api/FastReport.DatabaseLoginEventArgs.html +++ b/ClassReference/api/FastReport.DatabaseLoginEventArgs.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.DatabaseLoginEventHandler.html b/ClassReference/api/FastReport.DatabaseLoginEventHandler.html index 05143f1..5dea8e9 100644 --- a/ClassReference/api/FastReport.DatabaseLoginEventHandler.html +++ b/ClassReference/api/FastReport.DatabaseLoginEventHandler.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.DefaultPaperSize.html b/ClassReference/api/FastReport.DefaultPaperSize.html index cb1e107..104cc43 100644 --- a/ClassReference/api/FastReport.DefaultPaperSize.html +++ b/ClassReference/api/FastReport.DefaultPaperSize.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Duplicates.html b/ClassReference/api/FastReport.Duplicates.html index dc47c2b..7394c93 100644 --- a/ClassReference/api/FastReport.Duplicates.html +++ b/ClassReference/api/FastReport.Duplicates.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Engine.ReportEngine.html b/ClassReference/api/FastReport.Engine.ReportEngine.html index ff8d5aa..37d81f2 100644 --- a/ClassReference/api/FastReport.Engine.ReportEngine.html +++ b/ClassReference/api/FastReport.Engine.ReportEngine.html @@ -10,7 +10,7 @@ - + @@ -458,6 +458,58 @@
Property Value
+ +

IsKeeping

+

Returns true of keeping is enabled

+
+
+
Declaration
+
+
public bool IsKeeping { get; }
+
+
Property Value
+ + + + + + + + + + + + + +
TypeDescription
System.Boolean
+ + + +

KeepCurY

+

Returns keeping position

+
+
+
Declaration
+
+
public float KeepCurY { get; }
+
+
Property Value
+ + + + + + + + + + + + + +
TypeDescription
System.Single
+ +

OutlineXml

Gets xml containing outline nodes.

diff --git a/ClassReference/api/FastReport.Engine.html b/ClassReference/api/FastReport.Engine.html index bed47bf..e756684 100644 --- a/ClassReference/api/FastReport.Engine.html +++ b/ClassReference/api/FastReport.Engine.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Export.ExportBase.html b/ClassReference/api/FastReport.Export.ExportBase.html index 1944b5d..15a0bd8 100644 --- a/ClassReference/api/FastReport.Export.ExportBase.html +++ b/ClassReference/api/FastReport.Export.ExportBase.html @@ -10,7 +10,7 @@ - + @@ -646,7 +646,8 @@

Methods

Assign(Base)

-
+

Copies the contents of another, similar object.

+
Declaration
@@ -665,12 +666,28 @@
Parameters
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(Base) method. +

+
+
See Also
+ @@ -876,51 +893,6 @@
Returns
- -

GetOverlayPage(ReportPage)

-

Gets a report page with OverlayBand if it is a Demo or Academic.

-
-
-
Declaration
-
-
protected ReportPage GetOverlayPage(ReportPage page)
-
-
Parameters
- - - - - - - - - - - - - - - -
TypeNameDescription
ReportPagepage

The prepared report page

-
-
Returns
- - - - - - - - - - - - - -
TypeDescription
ReportPage

The prepared report page with OverlayBand.

-
- -

GetPage(Int32)

Gets a report page with specified index.

@@ -968,7 +940,8 @@
Returns

Serialize(FRWriter)

-
+

Serializes the object.

+
Declaration
@@ -987,12 +960,24 @@
Parameters
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(Base) methods; +
  • saving the object to the designer's clipboard;
  • saving the object to the preview (when run a +report).
+
diff --git a/ClassReference/api/FastReport.Export.ExportUtils.html b/ClassReference/api/FastReport.Export.ExportUtils.html index 3c9fb34..ed5a251 100644 --- a/ClassReference/api/FastReport.Export.ExportUtils.html +++ b/ClassReference/api/FastReport.Export.ExportUtils.html @@ -10,7 +10,7 @@ - + @@ -115,6 +115,48 @@

Methods

+ +

FloatToString(Double)

+
+
+
Declaration
+
+
public static string FloatToString(double value)
+
+
Parameters
+ + + + + + + + + + + + + + + +
TypeNameDescription
System.Doublevalue
+
Returns
+ + + + + + + + + + + + + +
TypeDescription
System.String
+ +

GetPageHeight(ReportPage)

Gets current page height.

diff --git a/ClassReference/api/FastReport.Export.Html.CustomDrawEventArgs.html b/ClassReference/api/FastReport.Export.Html.CustomDrawEventArgs.html index efc6b26..67bbc3e 100644 --- a/ClassReference/api/FastReport.Export.Html.CustomDrawEventArgs.html +++ b/ClassReference/api/FastReport.Export.Html.CustomDrawEventArgs.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Export.Html.HTMLExport.ExportType.html b/ClassReference/api/FastReport.Export.Html.HTMLExport.ExportType.html index 40eb5e3..f5155d7 100644 --- a/ClassReference/api/FastReport.Export.Html.HTMLExport.ExportType.html +++ b/ClassReference/api/FastReport.Export.Html.HTMLExport.ExportType.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Export.Html.HTMLExport.html b/ClassReference/api/FastReport.Export.Html.HTMLExport.html index e2e95cf..b922cde 100644 --- a/ClassReference/api/FastReport.Export.Html.HTMLExport.html +++ b/ClassReference/api/FastReport.Export.Html.HTMLExport.html @@ -10,7 +10,7 @@ - + @@ -137,9 +137,6 @@
Inherited Members
- @@ -331,6 +328,32 @@
Property Value
+ +

EmbeddedImages

+

Gets or sets images, embedded in html (hash:base64Image)

+
+
+
Declaration
+
+
public Dictionary<string, string> EmbeddedImages { get; set; }
+
+
Property Value
+ + + + + + + + + + + + + +
TypeDescription
System.Collections.Generic.Dictionary<System.String, System.String>
+ +

EmbedPictures

Enable or disable embedding pictures in HTML export

@@ -1011,7 +1034,8 @@

Methods

ExportPageBegin(ReportPage)

-
+

This method is called at the start of exports of each page.

+
Declaration
@@ -1030,7 +1054,8 @@
Parameters
ReportPage page - +

Page for export may be empty in this method.

+ @@ -1040,7 +1065,8 @@
Overrides

ExportPageEnd(ReportPage)

-
+

This method is called at the end of exports of each page.

+
Declaration
@@ -1059,7 +1085,8 @@
Parameters
ReportPage page - +

Page for export may be empty in this method.

+ @@ -1069,7 +1096,8 @@
Overrides

Finish()

-
+

This method is called when the export is finished.

+
Declaration
@@ -1081,7 +1109,8 @@
Overrides

GetFileFilter()

-
+

Returns a file filter for a save dialog.

+
Declaration
@@ -1098,7 +1127,8 @@
Returns
System.String - +

String that contains a file filter, for example: "Bitmap image (.bmp)|.bmp"

+ @@ -1218,7 +1248,8 @@
Parameters

Serialize(FRWriter)

-
+

Serializes the object.

+
Declaration
@@ -1237,17 +1268,30 @@
Parameters
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(Base) methods; +
  • saving the object to the designer's clipboard;
  • saving the object to the preview (when run a +report).
+

Start()

-
+

This method is called when the export starts.

+
Declaration
diff --git a/ClassReference/api/FastReport.Export.Html.HTMLExportFormat.html b/ClassReference/api/FastReport.Export.Html.HTMLExportFormat.html index 3ba912b..3069e5a 100644 --- a/ClassReference/api/FastReport.Export.Html.HTMLExportFormat.html +++ b/ClassReference/api/FastReport.Export.Html.HTMLExportFormat.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Export.Html.HTMLPageData.html b/ClassReference/api/FastReport.Export.Html.HTMLPageData.html index 4ee75bd..21a2a78 100644 --- a/ClassReference/api/FastReport.Export.Html.HTMLPageData.html +++ b/ClassReference/api/FastReport.Export.Html.HTMLPageData.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Export.Html.HtmlSizeUnits.html b/ClassReference/api/FastReport.Export.Html.HtmlSizeUnits.html index 8dd6de4..0474dbc 100644 --- a/ClassReference/api/FastReport.Export.Html.HtmlSizeUnits.html +++ b/ClassReference/api/FastReport.Export.Html.HtmlSizeUnits.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Export.Html.HtmlTemplates.html b/ClassReference/api/FastReport.Export.Html.HtmlTemplates.html index 92efa47..2a17acd 100644 --- a/ClassReference/api/FastReport.Export.Html.HtmlTemplates.html +++ b/ClassReference/api/FastReport.Export.Html.HtmlTemplates.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Export.Html.ImageFormat.html b/ClassReference/api/FastReport.Export.Html.ImageFormat.html index 15b2208..a8e37be 100644 --- a/ClassReference/api/FastReport.Export.Html.ImageFormat.html +++ b/ClassReference/api/FastReport.Export.Html.ImageFormat.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Export.Html.html b/ClassReference/api/FastReport.Export.Html.html index 8c928e4..7f757ca 100644 --- a/ClassReference/api/FastReport.Export.Html.html +++ b/ClassReference/api/FastReport.Export.Html.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Export.Image.ImageExport.html b/ClassReference/api/FastReport.Export.Image.ImageExport.html index 1b67d66..0afb7b8 100644 --- a/ClassReference/api/FastReport.Export.Image.ImageExport.html +++ b/ClassReference/api/FastReport.Export.Image.ImageExport.html @@ -10,7 +10,7 @@ - + @@ -134,9 +134,6 @@
Inherited Members
- @@ -590,7 +587,7 @@
Property Value
Remarks
-

If this property is set to true, the export filter will produce one big image +

If this property is set to false, the export filter will produce one big image containing all exported pages. Be careful using this property with a big report because it may produce out of memory error.

@@ -600,7 +597,8 @@

Methods

ExportBand(Base)

-
+

This method is called for each band on exported page.

+
Declaration
@@ -619,7 +617,8 @@
Parameters
Base band - +

Band, dispose after method compite.

+ @@ -629,7 +628,8 @@
Overrides

ExportPageBegin(ReportPage)

-
+

This method is called at the start of exports of each page.

+
Declaration
@@ -648,7 +648,8 @@
Parameters
ReportPage page - +

Page for export may be empty in this method.

+ @@ -658,7 +659,8 @@
Overrides

ExportPageEnd(ReportPage)

-
+

This method is called at the end of exports of each page.

+
Declaration
@@ -677,7 +679,8 @@
Parameters
ReportPage page - +

Page for export may be empty in this method.

+ @@ -687,7 +690,8 @@
Overrides

Finish()

-
+

This method is called when the export is finished.

+
Declaration
@@ -699,7 +703,8 @@
Overrides

GetFileFilter()

-
+

Returns a file filter for a save dialog.

+
Declaration
@@ -716,7 +721,8 @@
Returns
System.String - +

String that contains a file filter, for example: "Bitmap image (.bmp)|.bmp"

+ @@ -726,7 +732,8 @@
Overrides

Serialize(FRWriter)

-
+

Serializes the object.

+
Declaration
@@ -745,17 +752,30 @@
Parameters
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(Base) methods; +
  • saving the object to the designer's clipboard;
  • saving the object to the preview (when run a +report).
+

Start()

-
+

This method is called when the export starts.

+
Declaration
diff --git a/ClassReference/api/FastReport.Export.Image.ImageExportFormat.html b/ClassReference/api/FastReport.Export.Image.ImageExportFormat.html index d68c281..90a4a46 100644 --- a/ClassReference/api/FastReport.Export.Image.ImageExportFormat.html +++ b/ClassReference/api/FastReport.Export.Image.ImageExportFormat.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Export.Image.html b/ClassReference/api/FastReport.Export.Image.html index 4bf62e7..0152f44 100644 --- a/ClassReference/api/FastReport.Export.Image.html +++ b/ClassReference/api/FastReport.Export.Image.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Export.html b/ClassReference/api/FastReport.Export.html index 245d9be..17166c9 100644 --- a/ClassReference/api/FastReport.Export.html +++ b/ClassReference/api/FastReport.Export.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.FillBase.html b/ClassReference/api/FastReport.FillBase.html index d737705..26e5c77 100644 --- a/ClassReference/api/FastReport.FillBase.html +++ b/ClassReference/api/FastReport.FillBase.html @@ -10,7 +10,7 @@ - + @@ -85,6 +85,7 @@
Inheritance
+
Inherited Members
@@ -192,6 +193,95 @@
Returns
+ +

CreateBrush(RectangleF, Single, Single)

+

Creates the GDI+ Brush object with scaling.

+
+
+
Declaration
+
+
public virtual Brush CreateBrush(RectangleF rect, float scaleX, float scaleY)
+
+
Parameters
+ + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescription
RectangleFrect

Drawing rectangle.

+
System.SinglescaleX

X scaling coefficient.

+
System.SinglescaleY

Y scaling coefficient.

+
+
Returns
+ + + + + + + + + + + + + +
TypeDescription
Brush

Brush object.

+
+ + + +

Deserialize(FRReader, String)

+
+
+
Declaration
+
+
public virtual void Deserialize(FRReader reader, string prefix)
+
+
Parameters
+ + + + + + + + + + + + + + + + + + + + +
TypeNameDescription
FRReaderreader
System.Stringprefix
+ +

Draw(FRPaintEventArgs, RectangleF)

Fills the specified rectangle.

@@ -227,6 +317,26 @@
Parameters
+ +

FinalizeComponent()

+
+
+
Declaration
+
+
public virtual void FinalizeComponent()
+
+ + + +

InitializeComponent()

+
+
+
Declaration
+
+
public virtual void InitializeComponent()
+
+ +

Serialize(FRWriter, String, FillBase)

Serializes the fill.

diff --git a/ClassReference/api/FastReport.FilterPropertiesEventArgs.html b/ClassReference/api/FastReport.FilterPropertiesEventArgs.html index 04f8f0a..4ca6c86 100644 --- a/ClassReference/api/FastReport.FilterPropertiesEventArgs.html +++ b/ClassReference/api/FastReport.FilterPropertiesEventArgs.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.FilterPropertiesEventHandler.html b/ClassReference/api/FastReport.FilterPropertiesEventHandler.html index aa94966..a346403 100644 --- a/ClassReference/api/FastReport.FilterPropertiesEventHandler.html +++ b/ClassReference/api/FastReport.FilterPropertiesEventHandler.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Flags.html b/ClassReference/api/FastReport.Flags.html index 5a6dec3..15ca20e 100644 --- a/ClassReference/api/FastReport.Flags.html +++ b/ClassReference/api/FastReport.Flags.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Format.BooleanFormat.html b/ClassReference/api/FastReport.Format.BooleanFormat.html index 0149aa7..e1402a3 100644 --- a/ClassReference/api/FastReport.Format.BooleanFormat.html +++ b/ClassReference/api/FastReport.Format.BooleanFormat.html @@ -10,7 +10,7 @@ - + @@ -192,7 +192,8 @@

Methods

Clone()

-
+

Creates exact copy of this format.

+
Declaration
@@ -209,7 +210,8 @@
Returns
FormatBase - +

The copy of this format.

+ @@ -263,7 +265,8 @@
Overrides

FormatValue(Object)

-
+

Formats the specified value.

+
Declaration
@@ -282,7 +285,8 @@
Parameters
System.Object value - +

The value to format.

+ @@ -297,7 +301,8 @@
Returns
System.String - +

The string that represents the formatted value.

+ diff --git a/ClassReference/api/FastReport.Format.CurrencyFormat.html b/ClassReference/api/FastReport.Format.CurrencyFormat.html index baceb05..144d873 100644 --- a/ClassReference/api/FastReport.Format.CurrencyFormat.html +++ b/ClassReference/api/FastReport.Format.CurrencyFormat.html @@ -10,7 +10,7 @@ - + @@ -332,7 +332,8 @@

Methods

Clone()

-
+

Creates exact copy of this format.

+
Declaration
@@ -349,7 +350,8 @@
Returns
FormatBase - +

The copy of this format.

+ @@ -403,7 +405,8 @@
Overrides

FormatValue(Object)

-
+

Formats the specified value.

+
Declaration
@@ -422,7 +425,8 @@
Parameters
System.Object value - +

The value to format.

+ @@ -437,7 +441,8 @@
Returns
System.String - +

The string that represents the formatted value.

+ diff --git a/ClassReference/api/FastReport.Format.CustomFormat.html b/ClassReference/api/FastReport.Format.CustomFormat.html index 4a6d5f0..2267ffa 100644 --- a/ClassReference/api/FastReport.Format.CustomFormat.html +++ b/ClassReference/api/FastReport.Format.CustomFormat.html @@ -10,7 +10,7 @@ - + @@ -173,7 +173,8 @@

Methods

Clone()

-
+

Creates exact copy of this format.

+
Declaration
@@ -190,7 +191,8 @@
Returns
FormatBase - +

The copy of this format.

+ @@ -244,7 +246,8 @@
Overrides

FormatValue(Object)

-
+

Formats the specified value.

+
Declaration
@@ -263,7 +266,8 @@
Parameters
System.Object value - +

The value to format.

+ @@ -278,7 +282,8 @@
Returns
System.String - +

The string that represents the formatted value.

+ diff --git a/ClassReference/api/FastReport.Format.DateFormat.html b/ClassReference/api/FastReport.Format.DateFormat.html index 976e419..ce43fed 100644 --- a/ClassReference/api/FastReport.Format.DateFormat.html +++ b/ClassReference/api/FastReport.Format.DateFormat.html @@ -10,7 +10,7 @@ - + @@ -151,7 +151,8 @@

Methods

Clone()

-
+

Creates exact copy of this format.

+
Declaration
@@ -168,7 +169,8 @@
Returns
FormatBase - +

The copy of this format.

+ diff --git a/ClassReference/api/FastReport.Format.FormatBase.html b/ClassReference/api/FastReport.Format.FormatBase.html index 2a8dee1..1e02370 100644 --- a/ClassReference/api/FastReport.Format.FormatBase.html +++ b/ClassReference/api/FastReport.Format.FormatBase.html @@ -10,7 +10,7 @@ - + @@ -185,7 +185,8 @@
Returns

Deserialize(FRReader)

-
+

Deserializes the object.

+
Declaration
@@ -204,7 +205,8 @@
Parameters
FRReader reader - +

Reader object.

+ @@ -257,7 +259,8 @@
Returns

Serialize(FRWriter)

-
+

Serializes the object.

+
Declaration
@@ -276,7 +279,8 @@
Parameters
FRWriter writer - +

Writer object.

+ diff --git a/ClassReference/api/FastReport.Format.FormatCollection.html b/ClassReference/api/FastReport.Format.FormatCollection.html index 75f53e7..2735ff3 100644 --- a/ClassReference/api/FastReport.Format.FormatCollection.html +++ b/ClassReference/api/FastReport.Format.FormatCollection.html @@ -10,7 +10,7 @@ - + @@ -402,7 +402,8 @@
Returns

Deserialize(FRReader)

-
+

Deserializes the object.

+
Declaration
@@ -421,7 +422,8 @@
Parameters
FRReader reader - +

Reader object.

+ @@ -610,7 +612,8 @@
Parameters

Serialize(FRWriter)

-
+

Serializes the object.

+
Declaration
@@ -629,7 +632,8 @@
Parameters
FRWriter writer - +

Writer object.

+ diff --git a/ClassReference/api/FastReport.Format.GeneralFormat.html b/ClassReference/api/FastReport.Format.GeneralFormat.html index 9716b8c..ddbaee1 100644 --- a/ClassReference/api/FastReport.Format.GeneralFormat.html +++ b/ClassReference/api/FastReport.Format.GeneralFormat.html @@ -10,7 +10,7 @@ - + @@ -125,7 +125,8 @@

Methods

Clone()

-
+

Creates exact copy of this format.

+
Declaration
@@ -142,7 +143,8 @@
Returns
FormatBase - +

The copy of this format.

+ @@ -196,7 +198,8 @@
Overrides

FormatValue(Object)

-
+

Formats the specified value.

+
Declaration
@@ -215,7 +218,8 @@
Parameters
System.Object value - +

The value to format.

+ @@ -230,7 +234,8 @@
Returns
System.String - +

The string that represents the formatted value.

+ diff --git a/ClassReference/api/FastReport.Format.NumberFormat.html b/ClassReference/api/FastReport.Format.NumberFormat.html index 17f18ca..f2a36c0 100644 --- a/ClassReference/api/FastReport.Format.NumberFormat.html +++ b/ClassReference/api/FastReport.Format.NumberFormat.html @@ -10,7 +10,7 @@ - + @@ -275,7 +275,8 @@

Methods

Clone()

-
+

Creates exact copy of this format.

+
Declaration
@@ -292,7 +293,8 @@
Returns
FormatBase - +

The copy of this format.

+ @@ -346,7 +348,8 @@
Overrides

FormatValue(Object)

-
+

Formats the specified value.

+
Declaration
@@ -365,7 +368,8 @@
Parameters
System.Object value - +

The value to format.

+ @@ -380,7 +384,8 @@
Returns
System.String - +

The string that represents the formatted value.

+ diff --git a/ClassReference/api/FastReport.Format.PercentFormat.html b/ClassReference/api/FastReport.Format.PercentFormat.html index 3bff012..b6dcdf7 100644 --- a/ClassReference/api/FastReport.Format.PercentFormat.html +++ b/ClassReference/api/FastReport.Format.PercentFormat.html @@ -10,7 +10,7 @@ - + @@ -332,7 +332,8 @@

Methods

Clone()

-
+

Creates exact copy of this format.

+
Declaration
@@ -349,7 +350,8 @@
Returns
FormatBase - +

The copy of this format.

+ @@ -403,7 +405,8 @@
Overrides

FormatValue(Object)

-
+

Formats the specified value.

+
Declaration
@@ -422,7 +425,8 @@
Parameters
System.Object value - +

The value to format.

+ @@ -437,7 +441,8 @@
Returns
System.String - +

The string that represents the formatted value.

+ diff --git a/ClassReference/api/FastReport.Format.TimeFormat.html b/ClassReference/api/FastReport.Format.TimeFormat.html index 1e6838a..f2e33cb 100644 --- a/ClassReference/api/FastReport.Format.TimeFormat.html +++ b/ClassReference/api/FastReport.Format.TimeFormat.html @@ -10,7 +10,7 @@ - + @@ -151,7 +151,8 @@

Methods

Clone()

-
+

Creates exact copy of this format.

+
Declaration
@@ -168,7 +169,8 @@
Returns
FormatBase - +

The copy of this format.

+ diff --git a/ClassReference/api/FastReport.Format.html b/ClassReference/api/FastReport.Format.html index 9d0fbaa..1376543 100644 --- a/ClassReference/api/FastReport.Format.html +++ b/ClassReference/api/FastReport.Format.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Functions.StdFunctions.html b/ClassReference/api/FastReport.Functions.StdFunctions.html index 3c3a86e..c046092 100644 --- a/ClassReference/api/FastReport.Functions.StdFunctions.html +++ b/ClassReference/api/FastReport.Functions.StdFunctions.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Functions.html b/ClassReference/api/FastReport.Functions.html index 9377ced..0f5d5b9 100644 --- a/ClassReference/api/FastReport.Functions.html +++ b/ClassReference/api/FastReport.Functions.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Gauge.GaugeLabel.html b/ClassReference/api/FastReport.Gauge.GaugeLabel.html index 54ba4cc..51e94c9 100644 --- a/ClassReference/api/FastReport.Gauge.GaugeLabel.html +++ b/ClassReference/api/FastReport.Gauge.GaugeLabel.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Gauge.GaugeObject.html b/ClassReference/api/FastReport.Gauge.GaugeObject.html index 68cec22..a3bacfb 100644 --- a/ClassReference/api/FastReport.Gauge.GaugeObject.html +++ b/ClassReference/api/FastReport.Gauge.GaugeObject.html @@ -10,7 +10,7 @@ - + @@ -106,9 +106,6 @@
Inherited Members
- @@ -217,6 +214,9 @@
Inherited Members
+ @@ -301,6 +301,9 @@
Inherited Members
+ @@ -391,9 +394,6 @@
Inherited Members
- @@ -757,7 +757,8 @@

Methods

Assign(Base)

-
+

Copies the contents of another, similar object.

+
Declaration
@@ -776,12 +777,28 @@
Parameters
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(Base) method. +

+
+
See Also
+ @@ -844,7 +861,8 @@
Overrides

GetData()

-
+

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

+
Declaration
@@ -852,11 +870,17 @@
Declaration
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. +

GetExpressions()

-
+

Gets all expressions contained in the object.

+
Declaration
@@ -873,17 +897,29 @@
Returns
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
@@ -902,12 +938,24 @@
Parameters
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(Base) methods; +
  • saving the object to the designer's clipboard;
  • saving the object to the preview (when run a +report).
+

Implements

IFRSerializable diff --git a/ClassReference/api/FastReport.Gauge.GaugePointer.html b/ClassReference/api/FastReport.Gauge.GaugePointer.html index 4f5a978..2875a39 100644 --- a/ClassReference/api/FastReport.Gauge.GaugePointer.html +++ b/ClassReference/api/FastReport.Gauge.GaugePointer.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Gauge.GaugeScale.html b/ClassReference/api/FastReport.Gauge.GaugeScale.html index 0394618..21ced83 100644 --- a/ClassReference/api/FastReport.Gauge.GaugeScale.html +++ b/ClassReference/api/FastReport.Gauge.GaugeScale.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Gauge.Linear.LinearGauge.html b/ClassReference/api/FastReport.Gauge.Linear.LinearGauge.html index 2f6e032..d393224 100644 --- a/ClassReference/api/FastReport.Gauge.Linear.LinearGauge.html +++ b/ClassReference/api/FastReport.Gauge.Linear.LinearGauge.html @@ -10,7 +10,7 @@ - + @@ -134,9 +134,6 @@
Inherited Members
- @@ -245,6 +242,9 @@
Inherited Members
+ @@ -329,6 +329,9 @@
Inherited Members
+ @@ -419,9 +422,6 @@
Inherited Members
- @@ -537,7 +537,8 @@

Methods

Assign(Base)

-
+

Copies the contents of another, similar object.

+
Declaration
@@ -556,17 +557,34 @@
Parameters
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(Base) method. +

+
+
See Also
+

Draw(FRPaintEventArgs)

-
+

Draws the gauge.

+
Declaration
@@ -585,7 +603,8 @@
Parameters
FRPaintEventArgs e - +

Draw event arguments.

+ @@ -595,7 +614,8 @@
Overrides

Serialize(FRWriter)

-
+

Serializes the object.

+
Declaration
@@ -614,12 +634,24 @@
Parameters
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(Base) methods; +
  • saving the object to the designer's clipboard;
  • saving the object to the preview (when run a +report).
+

Implements

IFRSerializable diff --git a/ClassReference/api/FastReport.Gauge.Linear.LinearPointer.html b/ClassReference/api/FastReport.Gauge.Linear.LinearPointer.html index 843e36e..eff228b 100644 --- a/ClassReference/api/FastReport.Gauge.Linear.LinearPointer.html +++ b/ClassReference/api/FastReport.Gauge.Linear.LinearPointer.html @@ -10,7 +10,7 @@ - + @@ -194,7 +194,8 @@

Methods

Assign(GaugePointer)

-
+

Copies the contents of another GaugePointer.

+
Declaration
@@ -213,7 +214,8 @@
Parameters
GaugePointer src - +

The GaugePointer instance to copy the contents from.

+ @@ -223,7 +225,8 @@
Overrides

Draw(FRPaintEventArgs)

-
+

Draws the gauge pointer.

+
Declaration
@@ -242,7 +245,8 @@
Parameters
FRPaintEventArgs e - +

Draw event arguments.

+ @@ -252,7 +256,8 @@
Overrides

Serialize(FRWriter, String, GaugePointer)

-
+

Serializes the gauge pointer.

+
Declaration
@@ -271,22 +276,28 @@
Parameters
FRWriter writer - +

Writer object.

+ System.String prefix - +

Gauge pointer property name.

+ GaugePointer diff - +

Another GaugePointer to compare with.

+
Overrides
+
Remarks
+

This method is for internal use only.

+
diff --git a/ClassReference/api/FastReport.Gauge.Linear.LinearScale.html b/ClassReference/api/FastReport.Gauge.Linear.LinearScale.html index f6d702e..00cb20e 100644 --- a/ClassReference/api/FastReport.Gauge.Linear.LinearScale.html +++ b/ClassReference/api/FastReport.Gauge.Linear.LinearScale.html @@ -10,7 +10,7 @@ - + @@ -143,7 +143,8 @@

Methods

Assign(GaugeScale)

-
+

Copies the contents of another GaugeScale.

+
Declaration
@@ -162,7 +163,8 @@
Parameters
GaugeScale src - +

The GaugeScale instance to copy the contents from.

+ @@ -172,7 +174,8 @@
Overrides

Draw(FRPaintEventArgs)

-
+

Draws the scale of gauge.

+
Declaration
@@ -191,7 +194,8 @@
Parameters
FRPaintEventArgs e - +

Draw event arguments.

+ @@ -201,7 +205,8 @@
Overrides

Serialize(FRWriter, String, GaugeScale)

-
+

Serializes the gauge scale.

+
Declaration
@@ -220,22 +225,28 @@
Parameters
FRWriter writer - +

Writer object.

+ System.String prefix - +

Scale property name.

+ GaugeScale diff - +

Another GaugeScale to compare with.

+
Overrides
+
Remarks
+

This method is for internal use only.

+
diff --git a/ClassReference/api/FastReport.Gauge.Linear.html b/ClassReference/api/FastReport.Gauge.Linear.html index 8712d11..4b46a2f 100644 --- a/ClassReference/api/FastReport.Gauge.Linear.html +++ b/ClassReference/api/FastReport.Gauge.Linear.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Gauge.Radial.RadialGauge.html b/ClassReference/api/FastReport.Gauge.Radial.RadialGauge.html index f2b45af..30c528c 100644 --- a/ClassReference/api/FastReport.Gauge.Radial.RadialGauge.html +++ b/ClassReference/api/FastReport.Gauge.Radial.RadialGauge.html @@ -10,7 +10,7 @@ - + @@ -137,9 +137,6 @@
Inherited Members
- @@ -248,6 +245,9 @@
Inherited Members
+ @@ -329,6 +329,9 @@
Inherited Members
+ @@ -416,9 +419,6 @@
Inherited Members
- @@ -504,7 +504,8 @@
Property Value

Height

-
+

Gets or sets the height of the object.

+
Declaration
@@ -527,6 +528,10 @@
Property Value
Overrides
+
Remarks
+

This property value is measured in the screen pixels. Use Units class to +convert a value to desired units.

+
@@ -635,7 +640,8 @@
Property Value

Width

-
+

Gets or sets the width of the object.

+
Declaration
@@ -658,13 +664,18 @@
Property Value
Overrides
+
Remarks
+

This property value is measured in the screen pixels. Use Units class to +convert a value to desired units.

+

Methods

Assign(Base)

-
+

Copies the contents of another, similar object.

+
Declaration
@@ -683,17 +694,34 @@
Parameters
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(Base) method. +

+
+
See Also
+

Draw(FRPaintEventArgs)

-
+

Draws the gauge.

+
Declaration
@@ -712,7 +740,8 @@
Parameters
FRPaintEventArgs e - +

Draw event arguments.

+ @@ -722,7 +751,8 @@
Overrides

Serialize(FRWriter)

-
+

Serializes the object.

+
Declaration
@@ -741,12 +771,24 @@
Parameters
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(Base) methods; +
  • saving the object to the designer's clipboard;
  • saving the object to the preview (when run a +report).
+

Implements

IFRSerializable diff --git a/ClassReference/api/FastReport.Gauge.Radial.RadialGaugePosition.html b/ClassReference/api/FastReport.Gauge.Radial.RadialGaugePosition.html index 3b0d058..8f229b5 100644 --- a/ClassReference/api/FastReport.Gauge.Radial.RadialGaugePosition.html +++ b/ClassReference/api/FastReport.Gauge.Radial.RadialGaugePosition.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Gauge.Radial.RadialGaugeType.html b/ClassReference/api/FastReport.Gauge.Radial.RadialGaugeType.html index 65cf8ef..0e629cb 100644 --- a/ClassReference/api/FastReport.Gauge.Radial.RadialGaugeType.html +++ b/ClassReference/api/FastReport.Gauge.Radial.RadialGaugeType.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Gauge.Radial.RadialPointer.html b/ClassReference/api/FastReport.Gauge.Radial.RadialPointer.html index cfe180f..edcf364 100644 --- a/ClassReference/api/FastReport.Gauge.Radial.RadialPointer.html +++ b/ClassReference/api/FastReport.Gauge.Radial.RadialPointer.html @@ -10,7 +10,7 @@ - + @@ -174,7 +174,8 @@

Methods

Assign(GaugePointer)

-
+

Copies the contents of another GaugePointer.

+
Declaration
@@ -193,7 +194,8 @@
Parameters
GaugePointer src - +

The GaugePointer instance to copy the contents from.

+ @@ -203,7 +205,8 @@
Overrides

Draw(FRPaintEventArgs)

-
+

Draws the gauge pointer.

+
Declaration
@@ -222,7 +225,8 @@
Parameters
FRPaintEventArgs e - +

Draw event arguments.

+ @@ -232,7 +236,8 @@
Overrides

Serialize(FRWriter, String, GaugePointer)

-
+

Serializes the gauge pointer.

+
Declaration
@@ -251,22 +256,28 @@
Parameters
FRWriter writer - +

Writer object.

+ System.String prefix - +

Gauge pointer property name.

+ GaugePointer diff - +

Another GaugePointer to compare with.

+
Overrides
+
Remarks
+

This method is for internal use only.

+
diff --git a/ClassReference/api/FastReport.Gauge.Radial.RadialScale.html b/ClassReference/api/FastReport.Gauge.Radial.RadialScale.html index ee5e81d..a8b1930 100644 --- a/ClassReference/api/FastReport.Gauge.Radial.RadialScale.html +++ b/ClassReference/api/FastReport.Gauge.Radial.RadialScale.html @@ -10,7 +10,7 @@ - + @@ -143,7 +143,8 @@

Methods

Assign(GaugeScale)

-
+

Copies the contents of another GaugeScale.

+
Declaration
@@ -162,7 +163,8 @@
Parameters
GaugeScale src - +

The GaugeScale instance to copy the contents from.

+ @@ -172,7 +174,8 @@
Overrides

Draw(FRPaintEventArgs)

-
+

Draws the scale of gauge.

+
Declaration
@@ -191,7 +194,8 @@
Parameters
FRPaintEventArgs e - +

Draw event arguments.

+ @@ -201,7 +205,8 @@
Overrides

Serialize(FRWriter, String, GaugeScale)

-
+

Serializes the gauge scale.

+
Declaration
@@ -220,22 +225,28 @@
Parameters
FRWriter writer - +

Writer object.

+ System.String prefix - +

Scale property name.

+ GaugeScale diff - +

Another GaugeScale to compare with.

+
Overrides
+
Remarks
+

This method is for internal use only.

+
diff --git a/ClassReference/api/FastReport.Gauge.Radial.html b/ClassReference/api/FastReport.Gauge.Radial.html index 8689621..aac2ee9 100644 --- a/ClassReference/api/FastReport.Gauge.Radial.html +++ b/ClassReference/api/FastReport.Gauge.Radial.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Gauge.ScaleTicks.html b/ClassReference/api/FastReport.Gauge.ScaleTicks.html index 6a3ab63..96c8077 100644 --- a/ClassReference/api/FastReport.Gauge.ScaleTicks.html +++ b/ClassReference/api/FastReport.Gauge.ScaleTicks.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Gauge.Simple.Progress.SimpleProgressGauge.html b/ClassReference/api/FastReport.Gauge.Simple.Progress.SimpleProgressGauge.html index 8174b15..b9d8203 100644 --- a/ClassReference/api/FastReport.Gauge.Simple.Progress.SimpleProgressGauge.html +++ b/ClassReference/api/FastReport.Gauge.Simple.Progress.SimpleProgressGauge.html @@ -10,7 +10,7 @@ - + @@ -138,9 +138,6 @@
Inherited Members
- @@ -249,6 +246,9 @@
Inherited Members
+ @@ -333,6 +333,9 @@
Inherited Members
+ @@ -423,9 +426,6 @@
Inherited Members
- @@ -541,7 +541,8 @@

Methods

Draw(FRPaintEventArgs)

-
+

Draws the gauge.

+
Declaration
@@ -560,7 +561,8 @@
Parameters
FRPaintEventArgs e - +

Draw event arguments.

+ diff --git a/ClassReference/api/FastReport.Gauge.Simple.Progress.SimpleProgressLabel.html b/ClassReference/api/FastReport.Gauge.Simple.Progress.SimpleProgressLabel.html index aafae62..30f86dc 100644 --- a/ClassReference/api/FastReport.Gauge.Simple.Progress.SimpleProgressLabel.html +++ b/ClassReference/api/FastReport.Gauge.Simple.Progress.SimpleProgressLabel.html @@ -10,7 +10,7 @@ - + @@ -73,7 +73,8 @@

Class SimpleProgressLabel

-
+

Represents a label of a gauge.

+
Inheritance
@@ -111,7 +112,8 @@

Constructors

SimpleProgressLabel(GaugeObject)

-
+

Initializes a new instance of the GaugeLabel class.

+
Declaration
@@ -166,7 +168,8 @@
Property Value

Text

-
+

Gets or sets the label text

+
Declaration
@@ -195,7 +198,8 @@

Methods

Draw(FRPaintEventArgs)

-
+

Draws the gauge label.

+
Declaration
@@ -214,7 +218,8 @@
Parameters
FRPaintEventArgs e - +

Draw event arguments.

+ diff --git a/ClassReference/api/FastReport.Gauge.Simple.Progress.SimpleProgressPointer.html b/ClassReference/api/FastReport.Gauge.Simple.Progress.SimpleProgressPointer.html index 3669fea..d8197a1 100644 --- a/ClassReference/api/FastReport.Gauge.Simple.Progress.SimpleProgressPointer.html +++ b/ClassReference/api/FastReport.Gauge.Simple.Progress.SimpleProgressPointer.html @@ -10,7 +10,7 @@ - + @@ -73,7 +73,8 @@

Class SimpleProgressPointer

-
+

Represents a simple pointer.

+
Inheritance
@@ -124,7 +125,8 @@

Constructors

SimpleProgressPointer(GaugeObject)

-
+

Initializes a new instance of the SimplePointer class.

+
Declaration
@@ -143,7 +145,8 @@
Parameters
GaugeObject parent - +

The parent gauge object.

+ @@ -207,7 +210,8 @@

Methods

Assign(GaugePointer)

-
+

Copies the contents of another GaugePointer.

+
Declaration
@@ -226,7 +230,8 @@
Parameters
GaugePointer src - +

The GaugePointer instance to copy the contents from.

+ @@ -236,7 +241,8 @@
Overrides

Serialize(FRWriter, String, GaugePointer)

-
+

Serializes the gauge pointer.

+
Declaration
@@ -255,22 +261,28 @@
Parameters
FRWriter writer - +

Writer object.

+ System.String prefix - +

Gauge pointer property name.

+ GaugePointer diff - +

Another GaugePointer to compare with.

+
Overrides
+
Remarks
+

This method is for internal use only.

+
diff --git a/ClassReference/api/FastReport.Gauge.Simple.Progress.SimpleProgressPointerType.html b/ClassReference/api/FastReport.Gauge.Simple.Progress.SimpleProgressPointerType.html index 0e97d31..b8c6d07 100644 --- a/ClassReference/api/FastReport.Gauge.Simple.Progress.SimpleProgressPointerType.html +++ b/ClassReference/api/FastReport.Gauge.Simple.Progress.SimpleProgressPointerType.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Gauge.Simple.Progress.html b/ClassReference/api/FastReport.Gauge.Simple.Progress.html index f949c9c..8f473a6 100644 --- a/ClassReference/api/FastReport.Gauge.Simple.Progress.html +++ b/ClassReference/api/FastReport.Gauge.Simple.Progress.html @@ -10,7 +10,7 @@ - + @@ -81,9 +81,11 @@

SimpleProgressLabel

-
+

Represents a label of a gauge.

+

SimpleProgressPointer

-
+

Represents a simple pointer.

+

Enums

SimpleProgressPointerType

diff --git a/ClassReference/api/FastReport.Gauge.Simple.SimpleGauge.html b/ClassReference/api/FastReport.Gauge.Simple.SimpleGauge.html index 69b9557..8ce6551 100644 --- a/ClassReference/api/FastReport.Gauge.Simple.SimpleGauge.html +++ b/ClassReference/api/FastReport.Gauge.Simple.SimpleGauge.html @@ -10,7 +10,7 @@ - + @@ -141,9 +141,6 @@
Inherited Members
- @@ -252,6 +249,9 @@
Inherited Members
+ @@ -336,6 +336,9 @@
Inherited Members
+ @@ -426,9 +429,6 @@
Inherited Members
- @@ -518,7 +518,8 @@

Methods

Draw(FRPaintEventArgs)

-
+

Draws the gauge.

+
Declaration
@@ -537,7 +538,8 @@
Parameters
FRPaintEventArgs e - +

Draw event arguments.

+ diff --git a/ClassReference/api/FastReport.Gauge.Simple.SimplePointer.html b/ClassReference/api/FastReport.Gauge.Simple.SimplePointer.html index c5e4ea8..764d7c4 100644 --- a/ClassReference/api/FastReport.Gauge.Simple.SimplePointer.html +++ b/ClassReference/api/FastReport.Gauge.Simple.SimplePointer.html @@ -10,7 +10,7 @@ - + @@ -247,7 +247,8 @@

Methods

Assign(GaugePointer)

-
+

Copies the contents of another GaugePointer.

+
Declaration
@@ -266,7 +267,8 @@
Parameters
GaugePointer src - +

The GaugePointer instance to copy the contents from.

+ @@ -276,7 +278,8 @@
Overrides

Draw(FRPaintEventArgs)

-
+

Draws the gauge pointer.

+
Declaration
@@ -295,7 +298,8 @@
Parameters
FRPaintEventArgs e - +

Draw event arguments.

+ @@ -305,7 +309,8 @@
Overrides

Serialize(FRWriter, String, GaugePointer)

-
+

Serializes the gauge pointer.

+
Declaration
@@ -324,22 +329,28 @@
Parameters
FRWriter writer - +

Writer object.

+ System.String prefix - +

Gauge pointer property name.

+ GaugePointer diff - +

Another GaugePointer to compare with.

+
Overrides
+
Remarks
+

This method is for internal use only.

+
diff --git a/ClassReference/api/FastReport.Gauge.Simple.SimpleScale.html b/ClassReference/api/FastReport.Gauge.Simple.SimpleScale.html index cab7701..a7fe752 100644 --- a/ClassReference/api/FastReport.Gauge.Simple.SimpleScale.html +++ b/ClassReference/api/FastReport.Gauge.Simple.SimpleScale.html @@ -10,7 +10,7 @@ - + @@ -197,7 +197,8 @@

Methods

Assign(GaugeScale)

-
+

Copies the contents of another GaugeScale.

+
Declaration
@@ -216,7 +217,8 @@
Parameters
GaugeScale src - +

The GaugeScale instance to copy the contents from.

+ @@ -226,7 +228,8 @@
Overrides

Draw(FRPaintEventArgs)

-
+

Draws the scale of gauge.

+
Declaration
@@ -245,7 +248,8 @@
Parameters
FRPaintEventArgs e - +

Draw event arguments.

+ @@ -255,7 +259,8 @@
Overrides

Serialize(FRWriter, String, GaugeScale)

-
+

Serializes the gauge scale.

+
Declaration
@@ -274,22 +279,28 @@
Parameters
FRWriter writer - +

Writer object.

+ System.String prefix - +

Scale property name.

+ GaugeScale diff - +

Another GaugeScale to compare with.

+
Overrides
+
Remarks
+

This method is for internal use only.

+
diff --git a/ClassReference/api/FastReport.Gauge.Simple.SimpleSubScale.html b/ClassReference/api/FastReport.Gauge.Simple.SimpleSubScale.html index 301ea9d..00865da 100644 --- a/ClassReference/api/FastReport.Gauge.Simple.SimpleSubScale.html +++ b/ClassReference/api/FastReport.Gauge.Simple.SimpleSubScale.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Gauge.Simple.html b/ClassReference/api/FastReport.Gauge.Simple.html index 8c3f328..92bbdfa 100644 --- a/ClassReference/api/FastReport.Gauge.Simple.html +++ b/ClassReference/api/FastReport.Gauge.Simple.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Gauge.html b/ClassReference/api/FastReport.Gauge.html index 2350091..09fd3d8 100644 --- a/ClassReference/api/FastReport.Gauge.html +++ b/ClassReference/api/FastReport.Gauge.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.GetPropertyKindEventArgs.html b/ClassReference/api/FastReport.GetPropertyKindEventArgs.html index 3a2a3b7..5debd1c 100644 --- a/ClassReference/api/FastReport.GetPropertyKindEventArgs.html +++ b/ClassReference/api/FastReport.GetPropertyKindEventArgs.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.GetPropertyKindEventHandler.html b/ClassReference/api/FastReport.GetPropertyKindEventHandler.html index 42228a1..ff41d31 100644 --- a/ClassReference/api/FastReport.GetPropertyKindEventHandler.html +++ b/ClassReference/api/FastReport.GetPropertyKindEventHandler.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.GetTypeInstanceEventArgs.html b/ClassReference/api/FastReport.GetTypeInstanceEventArgs.html index 3fd2107..5c5e08e 100644 --- a/ClassReference/api/FastReport.GetTypeInstanceEventArgs.html +++ b/ClassReference/api/FastReport.GetTypeInstanceEventArgs.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.GetTypeInstanceEventHandler.html b/ClassReference/api/FastReport.GetTypeInstanceEventHandler.html index b1cbb35..6978bf5 100644 --- a/ClassReference/api/FastReport.GetTypeInstanceEventHandler.html +++ b/ClassReference/api/FastReport.GetTypeInstanceEventHandler.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.GlassFill.html b/ClassReference/api/FastReport.GlassFill.html index cdf67d2..88a6175 100644 --- a/ClassReference/api/FastReport.GlassFill.html +++ b/ClassReference/api/FastReport.GlassFill.html @@ -10,7 +10,7 @@ - + @@ -84,6 +84,18 @@
Inheritance
Inherited Members
+ + + +
System.Object.ToString()
@@ -249,7 +261,8 @@

Methods

Clone()

-
+

Creates exact copy of this fill.

+
Declaration
@@ -266,7 +279,8 @@
Returns
FillBase - +

Copy of this object.

+ @@ -276,7 +290,8 @@
Overrides

CreateBrush(RectangleF)

-
+

Creates the GDI+ Brush object.

+
Declaration
@@ -295,7 +310,8 @@
Parameters
RectangleF rect - +

Drawing rectangle.

+ @@ -310,7 +326,8 @@
Returns
Brush - +

Brush object.

+ @@ -320,7 +337,8 @@
Overrides

Draw(FRPaintEventArgs, RectangleF)

-
+

Fills the specified rectangle.

+
Declaration
@@ -339,12 +357,14 @@
Parameters
FRPaintEventArgs e - +

Draw event arguments.

+ RectangleF rect - +

Drawing rectangle.

+ @@ -425,7 +445,8 @@
Overrides

Serialize(FRWriter, String, FillBase)

-
+

Serializes the fill.

+
Declaration
@@ -444,22 +465,28 @@
Parameters
FRWriter writer - +

Writer object.

+ System.String prefix - +

Name of the fill property.

+ FillBase fill - +

Fill object to compare with.

+
Overrides
+
Remarks
+

This method is for internal use only.

+
diff --git a/ClassReference/api/FastReport.GraphicCache.html b/ClassReference/api/FastReport.GraphicCache.html index d9ef395..abc5c40 100644 --- a/ClassReference/api/FastReport.GraphicCache.html +++ b/ClassReference/api/FastReport.GraphicCache.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.GroupFooterBand.html b/ClassReference/api/FastReport.GroupFooterBand.html index 5853be9..195d0c3 100644 --- a/ClassReference/api/FastReport.GroupFooterBand.html +++ b/ClassReference/api/FastReport.GroupFooterBand.html @@ -10,7 +10,7 @@ - + @@ -115,6 +115,9 @@
Inherited Members
+ @@ -229,9 +232,6 @@
Inherited Members
- @@ -343,6 +343,9 @@
Inherited Members
+ @@ -409,6 +412,9 @@
Inherited Members
+ @@ -499,9 +505,6 @@
Inherited Members
- diff --git a/ClassReference/api/FastReport.GroupHeaderBand.html b/ClassReference/api/FastReport.GroupHeaderBand.html index eaa019f..484934f 100644 --- a/ClassReference/api/FastReport.GroupHeaderBand.html +++ b/ClassReference/api/FastReport.GroupHeaderBand.html @@ -10,7 +10,7 @@ - + @@ -109,6 +109,9 @@
Inherited Members
+ @@ -208,9 +211,6 @@
Inherited Members
- @@ -322,6 +322,9 @@
Inherited Members
+ @@ -388,6 +391,9 @@
Inherited Members
+ @@ -478,9 +484,6 @@
Inherited Members
- @@ -851,7 +854,8 @@

Methods

AddChild(Base)

-
+

Adds a child object to this object's childs.

+
Declaration
@@ -870,7 +874,8 @@
Parameters
Base child - +

Object to add.

+ @@ -880,7 +885,8 @@
Overrides

Assign(Base)

-
+

Copies the contents of another, similar object.

+
Declaration
@@ -899,17 +905,34 @@
Parameters
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(Base) method. +

+
+
See Also
+

CanContain(Base)

-
+

Gets a value indicating that this object can contain the specified child object.

+
Declaration
@@ -928,7 +951,8 @@
Parameters
Base child - +

Child object.

+ @@ -943,7 +967,8 @@
Returns
System.Boolean - +

true if this object can contain the specified child object; otherwise, false.

+ @@ -953,7 +978,8 @@
Overrides

GetChildObjects(ObjectCollection)

-
+

Gets a list of child objects.

+
Declaration
@@ -972,7 +998,8 @@
Parameters
ObjectCollection list - +

List to fill with values.

+ @@ -982,7 +1009,8 @@
Overrides

GetExpressions()

-
+

Gets all expressions contained in the object.

+
Declaration
@@ -999,17 +1027,29 @@
Returns
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. +

+

RemoveChild(Base)

-
+

Removes a specified object from this object's childs.

+
Declaration
@@ -1038,7 +1078,8 @@
Overrides

Serialize(FRWriter)

-
+

Serializes the object.

+
Declaration
@@ -1057,12 +1098,24 @@
Parameters
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(Base) methods; +
  • saving the object to the designer's clipboard;
  • saving the object to the preview (when run a +report).
+

Implements

IFRSerializable diff --git a/ClassReference/api/FastReport.HatchFill.html b/ClassReference/api/FastReport.HatchFill.html index 13b0a1e..270fa09 100644 --- a/ClassReference/api/FastReport.HatchFill.html +++ b/ClassReference/api/FastReport.HatchFill.html @@ -10,7 +10,7 @@ - + @@ -84,6 +84,18 @@
Inheritance
Inherited Members
+ + + + @@ -249,7 +261,8 @@

Methods

Clone()

-
+

Creates exact copy of this fill.

+
Declaration
@@ -266,7 +279,8 @@
Returns
FillBase - +

Copy of this object.

+ @@ -276,7 +290,8 @@
Overrides

CreateBrush(RectangleF)

-
+

Creates the GDI+ Brush object.

+
Declaration
@@ -295,7 +310,8 @@
Parameters
RectangleF rect - +

Drawing rectangle.

+ @@ -310,7 +326,8 @@
Returns
Brush - +

Brush object.

+ @@ -391,7 +408,8 @@
Overrides

Serialize(FRWriter, String, FillBase)

-
+

Serializes the fill.

+
Declaration
@@ -410,22 +428,28 @@
Parameters
FRWriter writer - +

Writer object.

+ System.String prefix - +

Name of the fill property.

+ FillBase fill - +

Fill object to compare with.

+
Overrides
+
Remarks
+

This method is for internal use only.

+
diff --git a/ClassReference/api/FastReport.HeaderFooterBandBase.html b/ClassReference/api/FastReport.HeaderFooterBandBase.html index 1c143b7..74716cd 100644 --- a/ClassReference/api/FastReport.HeaderFooterBandBase.html +++ b/ClassReference/api/FastReport.HeaderFooterBandBase.html @@ -10,7 +10,7 @@ - + @@ -107,6 +107,9 @@
Inherited Members
+ @@ -221,9 +224,6 @@
Inherited Members
- @@ -335,6 +335,9 @@
Inherited Members
+ @@ -401,6 +404,9 @@
Inherited Members
+ @@ -491,9 +497,6 @@
Inherited Members
- @@ -601,7 +604,8 @@

Methods

Assign(Base)

-
+

Copies the contents of another, similar object.

+
Declaration
@@ -620,17 +624,34 @@
Parameters
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(Base) method. +

+
+
See Also
+

Serialize(FRWriter)

-
+

Serializes the object.

+
Declaration
@@ -649,12 +670,24 @@
Parameters
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(Base) methods; +
  • saving the object to the designer's clipboard;
  • saving the object to the preview (when run a +report).
+

Implements

IFRSerializable diff --git a/ClassReference/api/FastReport.HighlightCondition.html b/ClassReference/api/FastReport.HighlightCondition.html index cb2275d..849ab72 100644 --- a/ClassReference/api/FastReport.HighlightCondition.html +++ b/ClassReference/api/FastReport.HighlightCondition.html @@ -10,7 +10,7 @@ - + @@ -219,7 +219,8 @@

Methods

Assign(StyleBase)

-
+

Assigns values from another source.

+
Declaration
@@ -238,7 +239,8 @@
Parameters
StyleBase source - +

Source to assign from.

+ @@ -346,7 +348,8 @@
Overrides

Serialize(FRWriter)

-
+

Serializes the style.

+
Declaration
@@ -365,12 +368,16 @@
Parameters
FRWriter writer - +

Writer object.

+
Overrides
+
Remarks
+

This method is for internal use only.

+

Implements

IFRSerializable diff --git a/ClassReference/api/FastReport.HorzAlign.html b/ClassReference/api/FastReport.HorzAlign.html index 6d8de25..daca620 100644 --- a/ClassReference/api/FastReport.HorzAlign.html +++ b/ClassReference/api/FastReport.HorzAlign.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.HtmlObject.html b/ClassReference/api/FastReport.HtmlObject.html index afc121b..c2fcf6a 100644 --- a/ClassReference/api/FastReport.HtmlObject.html +++ b/ClassReference/api/FastReport.HtmlObject.html @@ -10,7 +10,7 @@ - + @@ -155,9 +155,6 @@
Inherited Members
- @@ -257,6 +254,9 @@
Inherited Members
+ @@ -332,6 +332,9 @@
Inherited Members
+ @@ -419,9 +422,6 @@
Inherited Members
- @@ -516,7 +516,8 @@

Methods

ApplyStyle(Style)

-
+

Applies the style settings.

+
Declaration
@@ -535,7 +536,8 @@
Parameters
Style style - +

Style to apply.

+ @@ -545,7 +547,8 @@
Overrides

Assign(Base)

-
+

Copies the contents of another, similar object.

+
Declaration
@@ -564,17 +567,34 @@
Parameters
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(Base) method. +

+
+
See Also
+

Break(BreakableComponent)

-
+

Breaks the contents of the object.

+
Declaration
@@ -593,7 +613,9 @@
Parameters
BreakableComponent breakTo - +

Object to put the part of content to that does not fit in this object. These two +objects must have the same type.

+ @@ -608,17 +630,30 @@
Returns
System.Boolean - +

true if there is enough space in this object to display at least one text line.

+
Overrides
+
Remarks
+

+Do not call this method directly, it is used by the report engine. You should override it if +you are writing a new FastReport object. +

+

+This method must break the contents of the object. The part of content that fit in current object's +bounds should remain in this object, the part that does not fit should be transferred to breakTo +object. +

+

CalcHeight()

-
+

Calculates the object's height.

+
Declaration
@@ -635,12 +670,17 @@
Returns
System.Single - +

Actual object's height, in pixels.

+
Overrides
+
Remarks
+

Applicable to objects that contain several text lines, such as TextObject. Returns the height needed +to display all the text lines.

+
@@ -730,7 +770,8 @@
Parameters

GetData()

-
+

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

+
Declaration
@@ -738,11 +779,17 @@
Declaration
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. +

GetExpressions()

-
+

Gets all expressions contained in the object.

+
Declaration
@@ -759,17 +806,29 @@
Returns
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. +

+

RestoreState()

-
+

Restores the object's state after printing it.

+
Declaration
@@ -777,11 +836,17 @@
Declaration
Overrides
+
Remarks
+

This method is called by the report engine after 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 restore the object properties that were saved by the SaveState() method. +

RestoreStyle()

-
+

Restores the current style.

+
Declaration
@@ -793,7 +858,8 @@
Overrides

SaveState()

-
+

Saves the object's state before printing it.

+
Declaration
@@ -801,11 +867,18 @@
Declaration
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 save any object properties that may be changed during the object printing. +The standard implementation saves the object's bounds, visibility, bookmark and hyperlink. +

SaveStyle()

-
+

Saves the current style.

+
Declaration
@@ -817,7 +890,8 @@
Overrides

Serialize(FRWriter)

-
+

Serializes the object.

+
Declaration
@@ -836,12 +910,24 @@
Parameters
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(Base) methods; +
  • saving the object to the designer's clipboard;
  • saving the object to the preview (when run a +report).
+

Implements

IFRSerializable diff --git a/ClassReference/api/FastReport.Hyperlink.html b/ClassReference/api/FastReport.Hyperlink.html index b539093..b7c442e 100644 --- a/ClassReference/api/FastReport.Hyperlink.html +++ b/ClassReference/api/FastReport.Hyperlink.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.HyperlinkKind.html b/ClassReference/api/FastReport.HyperlinkKind.html index 8d907e4..a86e3ac 100644 --- a/ClassReference/api/FastReport.HyperlinkKind.html +++ b/ClassReference/api/FastReport.HyperlinkKind.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.IFRSerializable.html b/ClassReference/api/FastReport.IFRSerializable.html index 836be8a..fc24a1f 100644 --- a/ClassReference/api/FastReport.IFRSerializable.html +++ b/ClassReference/api/FastReport.IFRSerializable.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.IParent.html b/ClassReference/api/FastReport.IParent.html index bbe4bdd..f567a10 100644 --- a/ClassReference/api/FastReport.IParent.html +++ b/ClassReference/api/FastReport.IParent.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.ImageAlign.html b/ClassReference/api/FastReport.ImageAlign.html new file mode 100644 index 0000000..2fe4b78 --- /dev/null +++ b/ClassReference/api/FastReport.ImageAlign.html @@ -0,0 +1,182 @@ + + + + + + + + Enum ImageAlign + | FastReport OpenSource Class Reference + + + + + + + + + + + + + + + +
+
+ + + + +
+ + + +
+ + + + + + diff --git a/ClassReference/api/FastReport.JsonBase.html b/ClassReference/api/FastReport.JsonBase.html new file mode 100644 index 0000000..b7add0d --- /dev/null +++ b/ClassReference/api/FastReport.JsonBase.html @@ -0,0 +1,487 @@ + + + + + + + + Class JsonBase + | FastReport OpenSource Class Reference + + + + + + + + + + + + + + + +
+
+ + + + +
+ + + +
+ + + + + + diff --git a/ClassReference/api/FastReport.Language.html b/ClassReference/api/FastReport.Language.html index 2526e74..4f4f74a 100644 --- a/ClassReference/api/FastReport.Language.html +++ b/ClassReference/api/FastReport.Language.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.LineObject.html b/ClassReference/api/FastReport.LineObject.html index 00726c1..56b8e00 100644 --- a/ClassReference/api/FastReport.LineObject.html +++ b/ClassReference/api/FastReport.LineObject.html @@ -10,7 +10,7 @@ - + @@ -102,9 +102,6 @@
Inherited Members
- @@ -213,6 +210,9 @@
Inherited Members
+ @@ -303,6 +303,9 @@
Inherited Members
+ @@ -393,9 +396,6 @@
Inherited Members
- @@ -543,7 +543,8 @@

Methods

Assign(Base)

-
+

Copies the contents of another, similar object.

+
Declaration
@@ -562,12 +563,28 @@
Parameters
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(Base) method. +

+
+
See Also
+ @@ -601,7 +618,8 @@
Overrides

Serialize(FRWriter)

-
+

Serializes the object.

+
Declaration
@@ -620,12 +638,24 @@
Parameters
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(Base) methods; +
  • saving the object to the designer's clipboard;
  • saving the object to the preview (when run a +report).
+

Implements

IFRSerializable diff --git a/ClassReference/api/FastReport.LineSpacingType.html b/ClassReference/api/FastReport.LineSpacingType.html index f336d45..2a2b795 100644 --- a/ClassReference/api/FastReport.LineSpacingType.html +++ b/ClassReference/api/FastReport.LineSpacingType.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.LineStyle.html b/ClassReference/api/FastReport.LineStyle.html index 5f24b92..1f04269 100644 --- a/ClassReference/api/FastReport.LineStyle.html +++ b/ClassReference/api/FastReport.LineStyle.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.LinearGradientFill.html b/ClassReference/api/FastReport.LinearGradientFill.html index bbc5e9d..83191b9 100644 --- a/ClassReference/api/FastReport.LinearGradientFill.html +++ b/ClassReference/api/FastReport.LinearGradientFill.html @@ -10,7 +10,7 @@ - + @@ -84,6 +84,18 @@
Inheritance
Inherited Members
+ + + + @@ -395,7 +407,8 @@

Methods

Clone()

-
+

Creates exact copy of this fill.

+
Declaration
@@ -412,7 +425,8 @@
Returns
FillBase - +

Copy of this object.

+ @@ -422,7 +436,8 @@
Overrides

CreateBrush(RectangleF)

-
+

Creates the GDI+ Brush object.

+
Declaration
@@ -441,7 +456,8 @@
Parameters
RectangleF rect - +

Drawing rectangle.

+ @@ -456,7 +472,8 @@
Returns
Brush - +

Brush object.

+ @@ -537,7 +554,8 @@
Overrides

Serialize(FRWriter, String, FillBase)

-
+

Serializes the fill.

+
Declaration
@@ -556,22 +574,28 @@
Parameters
FRWriter writer - +

Writer object.

+ System.String prefix - +

Name of the fill property.

+ FillBase fill - +

Fill object to compare with.

+
Overrides
+
Remarks
+

This method is for internal use only.

+
diff --git a/ClassReference/api/FastReport.Matrix.MatrixAggregateFunction.html b/ClassReference/api/FastReport.Matrix.MatrixAggregateFunction.html index 29d954d..597a87c 100644 --- a/ClassReference/api/FastReport.Matrix.MatrixAggregateFunction.html +++ b/ClassReference/api/FastReport.Matrix.MatrixAggregateFunction.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Matrix.MatrixCellDescriptor.html b/ClassReference/api/FastReport.Matrix.MatrixCellDescriptor.html index a959e60..8a3f7bc 100644 --- a/ClassReference/api/FastReport.Matrix.MatrixCellDescriptor.html +++ b/ClassReference/api/FastReport.Matrix.MatrixCellDescriptor.html @@ -10,7 +10,7 @@ - + @@ -321,7 +321,8 @@

Methods

Assign(MatrixDescriptor)

-
+

Assigns values from another descriptor.

+
Declaration
@@ -340,7 +341,8 @@
Parameters
MatrixDescriptor source - +

Descriptor to assign values from.

+ @@ -350,7 +352,8 @@
Overrides

Serialize(FRWriter)

-
+

Serializes the object.

+
Declaration
@@ -369,7 +372,8 @@
Parameters
FRWriter writer - +

Writer object.

+ diff --git a/ClassReference/api/FastReport.Matrix.MatrixCells.html b/ClassReference/api/FastReport.Matrix.MatrixCells.html index 317f4fe..4ae0523 100644 --- a/ClassReference/api/FastReport.Matrix.MatrixCells.html +++ b/ClassReference/api/FastReport.Matrix.MatrixCells.html @@ -10,7 +10,7 @@ - + @@ -378,7 +378,8 @@
Returns

Deserialize(FRReader)

-
+

Deserializes the object.

+
Declaration
@@ -397,7 +398,8 @@
Parameters
FRReader reader - +

Reader object.

+ @@ -515,7 +517,8 @@
Parameters

Serialize(FRWriter)

-
+

Serializes the object.

+
Declaration
@@ -534,7 +537,8 @@
Parameters
FRWriter writer - +

Writer object.

+ diff --git a/ClassReference/api/FastReport.Matrix.MatrixData.html b/ClassReference/api/FastReport.Matrix.MatrixData.html index 24bae73..e622a7d 100644 --- a/ClassReference/api/FastReport.Matrix.MatrixData.html +++ b/ClassReference/api/FastReport.Matrix.MatrixData.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Matrix.MatrixDescriptor.html b/ClassReference/api/FastReport.Matrix.MatrixDescriptor.html index 6d4116d..c9c1a2a 100644 --- a/ClassReference/api/FastReport.Matrix.MatrixDescriptor.html +++ b/ClassReference/api/FastReport.Matrix.MatrixDescriptor.html @@ -10,7 +10,7 @@ - + @@ -282,7 +282,8 @@
Parameters

Deserialize(FRReader)

-
+

Deserializes the object.

+
Declaration
@@ -301,7 +302,8 @@
Parameters
FRReader reader - +

Reader object.

+ @@ -309,7 +311,8 @@
Parameters

Serialize(FRWriter)

-
+

Serializes the object.

+
Declaration
@@ -328,7 +331,8 @@
Parameters
FRWriter writer - +

Writer object.

+ diff --git a/ClassReference/api/FastReport.Matrix.MatrixEvenStylePriority.html b/ClassReference/api/FastReport.Matrix.MatrixEvenStylePriority.html index 872bd74..ab7f71c 100644 --- a/ClassReference/api/FastReport.Matrix.MatrixEvenStylePriority.html +++ b/ClassReference/api/FastReport.Matrix.MatrixEvenStylePriority.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Matrix.MatrixHeader.html b/ClassReference/api/FastReport.Matrix.MatrixHeader.html index a2c7997..8f6c6fd 100644 --- a/ClassReference/api/FastReport.Matrix.MatrixHeader.html +++ b/ClassReference/api/FastReport.Matrix.MatrixHeader.html @@ -10,7 +10,7 @@ - + @@ -378,7 +378,8 @@
Returns

Deserialize(FRReader)

-
+

Deserializes the object.

+
Declaration
@@ -397,7 +398,8 @@
Parameters
FRReader reader - +

Reader object.

+ @@ -706,7 +708,8 @@
Parameters

Serialize(FRWriter)

-
+

Serializes the object.

+
Declaration
@@ -725,7 +728,8 @@
Parameters
FRWriter writer - +

Writer object.

+ diff --git a/ClassReference/api/FastReport.Matrix.MatrixHeaderDescriptor.html b/ClassReference/api/FastReport.Matrix.MatrixHeaderDescriptor.html index 6fd0d0e..0ade345 100644 --- a/ClassReference/api/FastReport.Matrix.MatrixHeaderDescriptor.html +++ b/ClassReference/api/FastReport.Matrix.MatrixHeaderDescriptor.html @@ -10,7 +10,7 @@ - + @@ -516,7 +516,8 @@

Methods

Assign(MatrixDescriptor)

-
+

Assigns values from another descriptor.

+
Declaration
@@ -535,7 +536,8 @@
Parameters
MatrixDescriptor source - +

Descriptor to assign values from.

+ @@ -545,7 +547,8 @@
Overrides

Serialize(FRWriter)

-
+

Serializes the object.

+
Declaration
@@ -564,7 +567,8 @@
Parameters
FRWriter writer - +

Writer object.

+ diff --git a/ClassReference/api/FastReport.Matrix.MatrixObject.html b/ClassReference/api/FastReport.Matrix.MatrixObject.html index e605573..84df939 100644 --- a/ClassReference/api/FastReport.Matrix.MatrixObject.html +++ b/ClassReference/api/FastReport.Matrix.MatrixObject.html @@ -10,7 +10,7 @@ - + @@ -144,6 +144,9 @@
Inherited Members
+ @@ -210,9 +213,6 @@
Inherited Members
- @@ -315,6 +315,9 @@
Inherited Members
+ @@ -381,6 +384,9 @@
Inherited Members
+ @@ -468,9 +474,6 @@
Inherited Members
- @@ -1101,7 +1104,8 @@

Assign(Base)

-
+

Copies the contents of another, similar object.

+
Declaration
@@ -1120,12 +1124,28 @@
Parameters
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(Base) method. +

+
+
See Also
+ @@ -1145,7 +1165,8 @@
Remarks

DeserializeSubItems(FRReader)

-
+

Deserializes nested object properties.

+
Declaration
@@ -1164,17 +1185,29 @@
Parameters
FRReader reader - +

Reader object.

+
Overrides
+
Remarks
+

Typically the object serializes all properties to the single xml item:

+
<TextObject Name="Text2" Left="18.9" Top="37.8" Width="283.5" Height="28.35"/>
+

Some objects like DataBand have child objects that serialized in subitems:

+
<DataBand Name="Data1" Top="163" Width="718.2" Height="18.9">
+  <TextObject Name="Text3" Left="18.9" Top="37.8" Width="283.5" Height="28.35"/>
+</DataBand>
+

To read such subitems, the DeserializeSubItems method is used. Base +implementation reads the child objects. You may override it to read some specific subitems.

+

FinalizeComponent()

-
+

Performs a finalization after the report is finished.

+
Declaration
@@ -1182,11 +1215,15 @@
Declaration
Overrides
+
Remarks
+

This method is used by the report engine, do not call it directly.

+

GetData()

-
+

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

+
Declaration
@@ -1194,11 +1231,17 @@
Declaration
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. +

GetExpressions()

-
+

Gets all expressions contained in the object.

+
Declaration
@@ -1215,17 +1258,29 @@
Returns
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. +

+

InitializeComponent()

-
+

Initializes the object before running a report.

+
Declaration
@@ -1233,11 +1288,15 @@
Declaration
Overrides
+
Remarks
+

This method is used by the report engine, do not call it directly.

+

OnAfterData(EventArgs)

-
+

This method fires the AfterData event and the script code connected to the AfterDataEvent.

+
Declaration
@@ -1256,7 +1315,8 @@
Parameters
System.EventArgs e - +

Event data.

+ @@ -1353,7 +1413,8 @@
Parameters

RestoreState()

-
+

Restores the object's state after printing it.

+
Declaration
@@ -1361,11 +1422,17 @@
Declaration
Overrides
+
Remarks
+

This method is called by the report engine after 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 restore the object properties that were saved by the SaveState() method. +

SaveState()

-
+

Saves the object's state before printing it.

+
Declaration
@@ -1373,11 +1440,18 @@
Declaration
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 save any object properties that may be changed during the object printing. +The standard implementation saves the object's bounds, visibility, bookmark and hyperlink. +

Serialize(FRWriter)

-
+

Serializes the object.

+
Declaration
@@ -1396,12 +1470,24 @@
Parameters
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(Base) methods; +
  • saving the object to the designer's clipboard;
  • saving the object to the preview (when run a +report).
+
diff --git a/ClassReference/api/FastReport.Matrix.MatrixPercent.html b/ClassReference/api/FastReport.Matrix.MatrixPercent.html index b80be80..50f40de 100644 --- a/ClassReference/api/FastReport.Matrix.MatrixPercent.html +++ b/ClassReference/api/FastReport.Matrix.MatrixPercent.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Matrix.html b/ClassReference/api/FastReport.Matrix.html index bd8f5ea..978bc28 100644 --- a/ClassReference/api/FastReport.Matrix.html +++ b/ClassReference/api/FastReport.Matrix.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.ObjectCollection.html b/ClassReference/api/FastReport.ObjectCollection.html index 6e6df27..694a835 100644 --- a/ClassReference/api/FastReport.ObjectCollection.html +++ b/ClassReference/api/FastReport.ObjectCollection.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.OverlayBand.html b/ClassReference/api/FastReport.OverlayBand.html index f3251bc..7421ece 100644 --- a/ClassReference/api/FastReport.OverlayBand.html +++ b/ClassReference/api/FastReport.OverlayBand.html @@ -10,7 +10,7 @@ - + @@ -99,6 +99,9 @@
Inherited Members
+ @@ -216,9 +219,6 @@
Inherited Members
- @@ -330,6 +330,9 @@
Inherited Members
+ @@ -396,6 +399,9 @@
Inherited Members
+ @@ -486,9 +492,6 @@
Inherited Members
- diff --git a/ClassReference/api/FastReport.PageBase.html b/ClassReference/api/FastReport.PageBase.html index ff5b308..b4f652b 100644 --- a/ClassReference/api/FastReport.PageBase.html +++ b/ClassReference/api/FastReport.PageBase.html @@ -10,7 +10,7 @@ - + @@ -141,6 +141,9 @@
Inherited Members
+ diff --git a/ClassReference/api/FastReport.PageCollection.html b/ClassReference/api/FastReport.PageCollection.html index 8077d8d..050931d 100644 --- a/ClassReference/api/FastReport.PageCollection.html +++ b/ClassReference/api/FastReport.PageCollection.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.PageColumns.html b/ClassReference/api/FastReport.PageColumns.html index 37d9d37..49f8b1d 100644 --- a/ClassReference/api/FastReport.PageColumns.html +++ b/ClassReference/api/FastReport.PageColumns.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.PageFooterBand.html b/ClassReference/api/FastReport.PageFooterBand.html index 55e1fc1..f693797 100644 --- a/ClassReference/api/FastReport.PageFooterBand.html +++ b/ClassReference/api/FastReport.PageFooterBand.html @@ -10,7 +10,7 @@ - + @@ -99,6 +99,9 @@
Inherited Members
+ @@ -216,9 +219,6 @@
Inherited Members
- @@ -330,6 +330,9 @@
Inherited Members
+ @@ -396,6 +399,9 @@
Inherited Members
+ @@ -486,9 +492,6 @@
Inherited Members
- diff --git a/ClassReference/api/FastReport.PageHeaderBand.html b/ClassReference/api/FastReport.PageHeaderBand.html index 5f1a4fc..2853c40 100644 --- a/ClassReference/api/FastReport.PageHeaderBand.html +++ b/ClassReference/api/FastReport.PageHeaderBand.html @@ -10,7 +10,7 @@ - + @@ -99,6 +99,9 @@
Inherited Members
+ @@ -216,9 +219,6 @@
Inherited Members
- @@ -330,6 +330,9 @@
Inherited Members
+ @@ -396,6 +399,9 @@
Inherited Members
+ @@ -486,9 +492,6 @@
Inherited Members
- diff --git a/ClassReference/api/FastReport.PageRange.html b/ClassReference/api/FastReport.PageRange.html index 886a75f..75099f1 100644 --- a/ClassReference/api/FastReport.PageRange.html +++ b/ClassReference/api/FastReport.PageRange.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.ParagraphFormat.html b/ClassReference/api/FastReport.ParagraphFormat.html index 664ebf9..3f28e16 100644 --- a/ClassReference/api/FastReport.ParagraphFormat.html +++ b/ClassReference/api/FastReport.ParagraphFormat.html @@ -10,7 +10,7 @@ - + @@ -86,18 +86,12 @@
Inherited Members
System.Object.ToString()
-
- System.Object.Equals(System.Object) -
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
-
- System.Object.GetHashCode() -
System.Object.GetType()
@@ -243,6 +237,79 @@
Property Value
+

Methods +

+ + + +

Equals(Object)

+
+
+
Declaration
+
+
public override bool Equals(object obj)
+
+
Parameters
+ + + + + + + + + + + + + + + +
TypeNameDescription
System.Objectobj
+
Returns
+ + + + + + + + + + + + + +
TypeDescription
System.Boolean
+
Overrides
+
System.Object.Equals(System.Object)
+ + + +

GetHashCode()

+
+
+
Declaration
+
+
public override int GetHashCode()
+
+
Returns
+ + + + + + + + + + + + + +
TypeDescription
System.Int32
+
Overrides
+
System.Object.GetHashCode()
diff --git a/ClassReference/api/FastReport.PathGradientFill.html b/ClassReference/api/FastReport.PathGradientFill.html index 9348858..a43a04e 100644 --- a/ClassReference/api/FastReport.PathGradientFill.html +++ b/ClassReference/api/FastReport.PathGradientFill.html @@ -10,7 +10,7 @@ - + @@ -84,6 +84,18 @@
Inheritance
Inherited Members
+ + + + @@ -249,7 +261,8 @@

Methods

Clone()

-
+

Creates exact copy of this fill.

+
Declaration
@@ -266,7 +279,8 @@
Returns
FillBase - +

Copy of this object.

+ @@ -276,7 +290,8 @@
Overrides

CreateBrush(RectangleF)

-
+

Creates the GDI+ Brush object.

+
Declaration
@@ -295,7 +310,8 @@
Parameters
RectangleF rect - +

Drawing rectangle.

+ @@ -310,7 +326,8 @@
Returns
Brush - +

Brush object.

+ @@ -391,7 +408,8 @@
Overrides

Serialize(FRWriter, String, FillBase)

-
+

Serializes the fill.

+
Declaration
@@ -410,22 +428,28 @@
Parameters
FRWriter writer - +

Writer object.

+ System.String prefix - +

Name of the fill property.

+ FillBase fill - +

Fill object to compare with.

+
Overrides
+
Remarks
+

This method is for internal use only.

+
diff --git a/ClassReference/api/FastReport.PathGradientStyle.html b/ClassReference/api/FastReport.PathGradientStyle.html index 46730c9..ddfceb5 100644 --- a/ClassReference/api/FastReport.PathGradientStyle.html +++ b/ClassReference/api/FastReport.PathGradientStyle.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.PictureObject.html b/ClassReference/api/FastReport.PictureObject.html index bf47980..4e560c0 100644 --- a/ClassReference/api/FastReport.PictureObject.html +++ b/ClassReference/api/FastReport.PictureObject.html @@ -10,7 +10,7 @@ - + @@ -82,7 +82,8 @@
Inheritance
-
PictureObject
+ +
PictureObject
Implements
@@ -90,6 +91,75 @@
Implements
Inherited Members
+ + + + + + + + + + + + + + + + + + + + + + + @@ -102,9 +172,6 @@
Inherited Members
- @@ -282,6 +349,9 @@
Inherited Members
+ @@ -404,17 +474,17 @@
Namespace: FastRepor
Assembly: FastReport.OpenSource.dll
Syntax
-
public class PictureObject : ReportComponentBase, IFRSerializable
+
public class PictureObject : PictureObjectBase, IFRSerializable
Remarks

The Picture object can display the following kind of pictures:

  • picture that is embedded in the report file. Use the Image - property to do this;
  • picture that is stored in the database BLOb field. Use the DataColumn - property to specify the name of data column you want to show;
  • picture that is stored in the local disk file. Use the ImageLocation - property to specify the name of the file;
  • picture that is stored in the Web. Use the ImageLocation + property to do this;
  • picture that is stored in the database BLOb field. Use the + property to specify the name of data column you want to show;
  • picture that is stored in the local disk file. Use the + property to specify the name of the file;
  • picture that is stored in the Web. Use the property to specify the picture's URL.
-

Use the SizeMode property to specify a size mode. The MaxWidth -and MaxHeight properties can be used to restrict the image size if SizeMode +

Use the property to specify a size mode. The +and properties can be used to restrict the image size if SizeMode is set to AutoSize.

The TransparentColor property can be used to display an image with transparent background. Use the Transparency property if you want to display @@ -437,58 +507,6 @@

Properties

- -

Angle

-

Gets or sets the image rotation angle, in degrees. Possible values are 0, 90, 180, 270.

-
-
-
Declaration
-
-
public int Angle { get; set; }
-
-
Property Value
- - - - - - - - - - - - - -
TypeDescription
System.Int32
- - - -

DataColumn

-

Gets or sets the data column name to get the image from.

-
-
-
Declaration
-
-
public string DataColumn { get; set; }
-
-
Property Value
- - - - - - - - - - - - - -
TypeDescription
System.String
- -

Grayscale

Gets or sets a value indicating that the image should be displayed in grayscale mode.

@@ -496,7 +514,7 @@

Declaration
-
public virtual bool Grayscale { get; set; }
+
public override bool Grayscale { get; set; }
Property Value
@@ -513,6 +531,8 @@
Property Value
+
Overrides
+ @@ -541,33 +561,6 @@
Property Value
- -

Height

-
-
-
Declaration
-
-
public override float Height { get; set; }
-
-
Property Value
- - - - - - - - - - - - - -
TypeDescription
System.Single
-
Overrides
- - -

Image

Gets or sets the image.

@@ -601,14 +594,14 @@
Remarks
- -

ImageLocation

-

Gets or sets the path for the image to display in the PictureObject.

+ +

ImageHeight

+

Return base size of image, internal use only

Declaration
-
public string ImageLocation { get; set; }
+
protected override float ImageHeight { get; }
Property Value
@@ -620,24 +613,23 @@
Property Value
- +
System.StringSystem.Single
-
Remarks
-

This property may contain the path to the image file as well as external URL.

-
+
Overrides
+ - -

IsDataColumn

-

Gets a value indicating that the image stored in the databases column

+ +

ImageWidth

+

Return base size of image, internal use only

Declaration
-
public bool IsDataColumn { get; }
+
protected override float ImageWidth { get; }
Property Value
@@ -649,21 +641,24 @@
Property Value
- +
System.BooleanSystem.Single
+
Overrides
+ - -

IsFileLocation

-

Gets a value indicating that the image stored in the separate file

+ +

ShouldDisposeImage

+

Gets or sets a value indicating that the image stored in the Image +property should be disposed when this object is disposed.

Declaration
-
public bool IsFileLocation { get; }
+
public bool ShouldDisposeImage { get; set; }
Property Value
@@ -680,16 +675,21 @@
Property Value
+
Remarks
+

By default, image assigned to the Image property is never disposed - you should +take care about it. If you want to dispose the image when this PictureObject is disposed, +set this property to true right after you assign an image to the Image property.

+
- -

IsWebLocation

-

Gets a value indicating that the image stored in the Web

+ +

Tile

+

Gets or sets a value indicating that the image should be tiled.

Declaration
-
public bool IsWebLocation { get; }
+
public bool Tile { get; set; }
Property Value
@@ -708,14 +708,14 @@
Property Value
- -

MaxHeight

-

Gets or sets the maximum height of a Picture object, in pixels.

+ +

Transparency

+

Gets or sets the transparency of the PictureObject.

Declaration
-
public float MaxHeight { get; set; }
+
public float Transparency { get; set; }
Property Value
@@ -732,20 +732,19 @@
Property Value
-
Remarks
-

Use this property to restrict the object size if the SizeMode property -is set to AutoSize.

+
Remarks
+

Valid range of values is 0..1. Default value is 0.

- -

MaxWidth

-

Gets or sets the maximum width of a Picture object, in pixels.

+ +

TransparentColor

+

Gets or sets the color of the image that will be treated as transparent.

Declaration
-
public float MaxWidth { get; set; }
+
public Color TransparentColor { get; set; }
Property Value
@@ -757,25 +756,21 @@
Property Value
- +
System.SingleColor
-
Remarks
-

Use this property to restrict the object size if the SizeMode property -is set to AutoSize.

-
- -

Padding

-

Gets or sets padding within the PictureObject.

+ +

TransparentImage

+

Gets or sets a bitmap transparent image

Declaration
-
public Padding Padding { get; set; }
+
public Bitmap TransparentImage { get; set; }
Property Value
@@ -787,419 +782,209 @@
Property Value
- +
PaddingBitmap
+

Methods +

- -

ShouldDisposeImage

-

Gets or sets a value indicating that the image stored in the Image -property should be disposed when this object is disposed.

+ +

Assign(Base)

+

Copies the contents of another, similar object.

Declaration
-
public bool ShouldDisposeImage { get; set; }
+
public override void Assign(Base source)
-
Property Value
+
Parameters
+ - - + + +
TypeName Description
System.BooleanBasesource

Source object to copy the contents from.

+
-
Remarks
-

By default, image assigned to the Image property is never disposed - you should -take care about it. If you want to dispose the image when this PictureObject is disposed, -set this property to true right after you assign an image to the Image property.

+
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(Base) method. +

+
See Also
+ - -

ShowErrorImage

-

Gets or sets a value indicating whether the PictureObject should display -the error indicator if there is no image in it.

-
+ +

Deserialize(FRReader)

+
Declaration
-
public bool ShowErrorImage { get; set; }
+
public override void Deserialize(FRReader reader)
-
Property Value
+
Parameters
+ - + +
TypeName Description
System.BooleanFRReaderreader
+
Overrides
+ - -

SizeMode

-

Gets or sets a value that specifies how an image is positioned within a PictureObject.

-
+ +

Dispose(Boolean)

+
Declaration
-
public virtual PictureBoxSizeMode SizeMode { get; set; }
+
protected override void Dispose(bool disposing)
-
Property Value
+
Parameters
+ - + +
TypeName Description
PictureBoxSizeModeSystem.Booleandisposing
+
Overrides
+ - -

Tile

-

Gets or sets a value indicating that the image should be tiled.

+ +

DisposeImage()

+

Disposes image

Declaration
-
public bool Tile { get; set; }
+
public void DisposeImage()
-
Property Value
- - - - - - - - - - - - - -
TypeDescription
System.Boolean
- -

Transparency

-

Gets or sets the transparency of the PictureObject.

+ +

DrawImage(FRPaintEventArgs)

+

Draws the image.

Declaration
-
public float Transparency { get; set; }
+
public override void DrawImage(FRPaintEventArgs e)
-
Property Value
+
Parameters
+ - - + + +
TypeName Description
System.SingleFRPaintEventArgse

Paint event args.

+
-
Remarks
-

Valid range of values is 0..1. Default value is 0.

-
+
Overrides
+ - -

TransparentColor

-

Gets or sets the color of the image that will be treated as transparent.

-
+ +

DrawImageInternal2(Graphics, PointF, PointF, PointF)

+
Declaration
-
public Color TransparentColor { get; set; }
+
protected override void DrawImageInternal2(Graphics graphics, PointF upperLeft, PointF upperRight, PointF lowerLeft)
-
Property Value
+
Parameters
+ - + + - -
TypeName Description
ColorGraphicsgraphics
- - - -

TransparentImage

-

Gets or sets a bitmap transparent image

-
-
-
Declaration
-
-
public Bitmap TransparentImage { get; set; }
-
-
Property Value
- - - - - - - - - - - - - -
TypeDescription
Bitmap
- - - -

Width

-
-
-
Declaration
-
-
public override float Width { get; set; }
-
-
Property Value
- - - - - - - - - - - - - -
TypeDescription
System.Single
-
Overrides
- -

Methods -

- - - -

Assign(Base)

-
-
-
Declaration
-
-
public override void Assign(Base source)
-
-
Parameters
- - - - - - - - - - - - - - - -
TypeNameDescription
Basesource
-
Overrides
- - - - -

CalculateUri()

-

Calculates URI from ImageLocation

-
-
-
Declaration
-
-
public Uri CalculateUri()
-
-
Returns
- - - - - - - - - - - - -
TypeDescription
Uri
- - - -

Deserialize(FRReader)

-
-
-
Declaration
-
-
public override void Deserialize(FRReader reader)
-
-
Parameters
- - - - - - - - - - - - + + - -
TypeNameDescription
FRReaderreaderPointFupperLeft
-
Overrides
- - - - -

Dispose(Boolean)

-
-
-
Declaration
-
-
protected override void Dispose(bool disposing)
-
-
Parameters
- - - - - - - - - - - + + - -
TypeNameDescription
System.BooleandisposingPointFupperRight
-
Overrides
- - - - -

DisposeImage()

-

Disposes image

-
-
-
Declaration
-
-
public void DisposeImage()
-
- - - -

Draw(FRPaintEventArgs)

-
-
-
Declaration
-
-
public override void Draw(FRPaintEventArgs e)
-
-
Parameters
- - - - - - - - - - - + +
TypeNameDescription
FRPaintEventArgsePointFlowerLeft
Overrides
- - - - -

DrawImage(FRPaintEventArgs)

-

Draws the image.

-
-
-
Declaration
-
-
public virtual void DrawImage(FRPaintEventArgs e)
-
-
Parameters
- - - - - - - - - - - - - - - -
TypeNameDescription
FRPaintEventArgse

Paint event args.

-
+

FinalizeComponent()

-
+

Performs a finalization after the report is finished.

+
Declaration
@@ -1207,6 +992,9 @@
Declaration
Overrides
+
Remarks
+

This method is used by the report engine, do not call it directly.

+
@@ -1229,7 +1017,8 @@
Remarks

GetData()

-
+

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

+
Declaration
@@ -1237,121 +1026,17 @@
Declaration
Overrides
- - - -

GetExpressions()

-
-
-
Declaration
-
-
public override string[] GetExpressions()
-
-
Returns
- - - - - - - - - - - - - -
TypeDescription
System.String[]
-
Overrides
- - - - -

GetImageAngleTransform(RectangleF, Single, Single, Single, Single, Single, Single, out PointF, out PointF, out PointF)

-

gets points for transform this image

+
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.

-
-
Declaration
-
-
public void GetImageAngleTransform(RectangleF drawRect, float imageWidth, float imageHeight, float scaleX, float scaleY, float offsetX, float offsetY, out PointF upperLeft, out PointF upperRight, out PointF lowerLeft)
-
-
Parameters
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescription
RectangleFdrawRect

the box where to draw image

-
System.SingleimageWidth

image width

-
System.SingleimageHeight

image height

-
System.SinglescaleX

scale horizontal

-
System.SinglescaleY

scale vertical

-
System.SingleoffsetX

offset of left

-
System.SingleoffsetY

offset of top

-
PointFupperLeft

out start of vectors

-
PointFupperRight

out end of frist vector

-
PointFlowerLeft

out end of second vector

-

InitializeComponent()

-
+

Initializes the object before running a report.

+
Declaration
@@ -1359,6 +1044,9 @@
Declaration
Overrides
+
Remarks
+

This method is used by the report engine, do not call it directly.

+
@@ -1368,133 +1056,22 @@

Declaration
-
public virtual void LoadImage()
-
- - - -

MovePointOnAngle(PointF, SizeF, Single)

-

Moves the point on specified angle

-
-
-
Declaration
-
-
public PointF MovePointOnAngle(PointF p, SizeF size, float fangle)
-
-
Parameters
- - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescription
PointFp
SizeFsize
System.Singlefangle
-
Returns
- - - - - - - - - - - - - -
TypeDescription
PointF
- - - -

RestoreState()

-
-
-
Declaration
-
-
public override void RestoreState()
+
public override void LoadImage()
Overrides
- - - - -

rotateVector(PointF, Single)

-

Rotates vector on specified angle

-
-
-
Declaration
-
-
public PointF rotateVector(PointF p, float fangle)
-
-
Parameters
- - - - - - - - - - - - - - - - - - - - -
TypeNameDescription
PointFp
System.Singlefangle
-
Returns
- - - - - - - - - - - - - -
TypeDescription
PointF
+ - -

SaveState()

+ +

ResetImageIndex()

Declaration
-
public override void SaveState()
+
protected override void ResetImageIndex()
Overrides
- + @@ -1523,7 +1100,7 @@
Parameters
Overrides
- + diff --git a/ClassReference/api/FastReport.PictureObjectBase.html b/ClassReference/api/FastReport.PictureObjectBase.html new file mode 100644 index 0000000..83559ad --- /dev/null +++ b/ClassReference/api/FastReport.PictureObjectBase.html @@ -0,0 +1,1438 @@ + + + + + + + + Class PictureObjectBase + | FastReport OpenSource Class Reference + + + + + + + + + + + + + + + +
+
+ + + + +
+ + + +
+ + + + + + diff --git a/ClassReference/api/FastReport.PolyLineObject.PolyPoint.html b/ClassReference/api/FastReport.PolyLineObject.PolyPoint.html new file mode 100644 index 0000000..7dd8694 --- /dev/null +++ b/ClassReference/api/FastReport.PolyLineObject.PolyPoint.html @@ -0,0 +1,471 @@ + + + + + + + + Class PolyLineObject.PolyPoint + | FastReport OpenSource Class Reference + + + + + + + + + + + + + + + +
+
+ + + + +
+ + + +
+ + + + + + diff --git a/ClassReference/api/FastReport.PolyLineObject.PolyPointCollection.html b/ClassReference/api/FastReport.PolyLineObject.PolyPointCollection.html new file mode 100644 index 0000000..1f29873 --- /dev/null +++ b/ClassReference/api/FastReport.PolyLineObject.PolyPointCollection.html @@ -0,0 +1,483 @@ + + + + + + + + Class PolyLineObject.PolyPointCollection + | FastReport OpenSource Class Reference + + + + + + + + + + + + + + + +
+
+ + + + +
+ + + +
+ + + + + + diff --git a/ClassReference/api/FastReport.PolyLineObject.PolygonSelectionMode.html b/ClassReference/api/FastReport.PolyLineObject.PolygonSelectionMode.html new file mode 100644 index 0000000..cae7299 --- /dev/null +++ b/ClassReference/api/FastReport.PolyLineObject.PolygonSelectionMode.html @@ -0,0 +1,151 @@ + + + + + + + + Enum PolyLineObject.PolygonSelectionMode + | FastReport OpenSource Class Reference + + + + + + + + + + + + + + + +
+
+ + + + +
+ + + +
+ + + + + + diff --git a/ClassReference/api/FastReport.PolyLineObject.html b/ClassReference/api/FastReport.PolyLineObject.html index 8da0960..463aac4 100644 --- a/ClassReference/api/FastReport.PolyLineObject.html +++ b/ClassReference/api/FastReport.PolyLineObject.html @@ -10,7 +10,7 @@ - + @@ -103,9 +103,6 @@
Inherited Members
- @@ -304,6 +301,9 @@
Inherited Members
+ @@ -451,6 +451,33 @@
Declaration
public PolyLineObject()
+

Fields +

+ + +

polygonSelectionMode

+

do not set this value, internal use only

+
+
+
Declaration
+
+
protected PolyLineObject.PolygonSelectionMode polygonSelectionMode
+
+
Field Value
+ + + + + + + + + + + + + +
TypeDescription
PolyLineObject.PolygonSelectionMode

Properties

@@ -507,14 +534,43 @@
Property Value
+ +

Points

+

Return points collection. +You can modify the collection for change this object.

+
+
+
Declaration
+
+
public PolyLineObject.PolyPointCollection Points { get; }
+
+
Property Value
+ + + + + + + + + + + + + +
TypeDescription
PolyLineObject.PolyPointCollection
+ +

PointsArray

-

Return points array of line

+

Return points array of line +deprecated

Declaration
-
public PointF[] PointsArray { get; }
+
[Obsolete]
+public PointF[] PointsArray { get; }
Property Value
@@ -535,12 +591,14 @@
Property Value

PointTypesArray

-

Return point types array. 0 - Start of line, 1 - Keep on line

+

Return point types array. 0 - Start of line, 1 - Keep on line +deprecated

Declaration
-
public byte[] PointTypesArray { get; }
+
[Obsolete]
+public byte[] PointTypesArray { get; }
Property Value
@@ -564,12 +622,14 @@

Methods

addPoint(Single, Single, Byte)

Add point to end of polyline, need to recalculate bounds after add -First point must have zero coordinate and zero type

+First point must have zero coordinate and zero type. +Recalculate bounds. +Method is slow do not use this.

Declaration
-
protected void addPoint(float localX, float localY, byte pointType)
+
protected PolyLineObject.PolyPoint addPoint(float localX, float localY, byte pointType)
Parameters
@@ -596,16 +656,32 @@
Parameters
-
System.Byte pointType

0-start,1-line

+

depreceted

+
Returns
+ + + + + + + + + + + + + +
TypeDescription
PolyLineObject.PolyPoint

Assign(Base)

-
+

Copies the contents of another, similar object.

+
Declaration
@@ -624,18 +700,35 @@
Parameters
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(Base) method. +

+
+
See Also
+

deletePoint(Int32)

-

Delete point from polyline by index -Recalculate bounds

+

Delete point from polyline by index. +Recalculate bounds. +Method is slow do not use this.

Declaration
@@ -688,7 +781,7 @@
Parameters
Overrides
- + @@ -832,12 +925,14 @@
Returns

insertPoint(Int32, Single, Single, Byte)

-

Insert point to desired place of polyline

+

Insert point to desired place of polyline +recalculateBounds(); +Method is slow do not use this

Declaration
-
protected void insertPoint(int index, float localX, float localY, byte pointType)
+
protected PolyLineObject.PolyPoint insertPoint(int index, float localX, float localY, byte pointType)
Parameters
@@ -870,27 +965,43 @@
Parameters
-
System.Byte pointType

0-start,1-line

+

deprecated

+
Returns
+ + + + + + + + + + + + + +
TypeDescription
PolyLineObject.PolyPoint
- -

recalculateBounds()

+ +

RecalculateBounds()

Recalculate position and size of element

Declaration
-
protected void recalculateBounds()
+
public void RecalculateBounds()

Serialize(FRWriter)

-
+

Serializes the object.

+
Declaration
@@ -909,12 +1020,51 @@
Parameters
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(Base) methods; +
  • saving the object to the designer's clipboard;
  • saving the object to the preview (when run a +report).
+
+ + + +

SetPolyLine(PointF[])

+
+
+
Declaration
+
+
public void SetPolyLine(PointF[] newPoints)
+
+
Parameters
+ + + + + + + + + + + + + + + +
TypeNameDescription
PointF[]newPoints

Implements

IFRSerializable diff --git a/ClassReference/api/FastReport.PolygonObject.html b/ClassReference/api/FastReport.PolygonObject.html index 7b8922b..af90fe2 100644 --- a/ClassReference/api/FastReport.PolygonObject.html +++ b/ClassReference/api/FastReport.PolygonObject.html @@ -10,7 +10,7 @@ - + @@ -91,6 +91,12 @@
Implements
Inherited Members
+ + @@ -104,28 +110,31 @@
Inherited Members
PolyLineObject.PointTypesArray
+
ReportComponentBase.BeforePrint @@ -139,9 +148,6 @@
Inherited Members
- @@ -340,6 +346,9 @@
Inherited Members
+ @@ -581,7 +590,8 @@
Returns

Serialize(FRWriter)

-
+

Serializes the object.

+
Declaration
@@ -600,12 +610,24 @@
Parameters
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(Base) methods; +
  • saving the object to the designer's clipboard;
  • saving the object to the preview (when run a +report).
+

Implements

IFRSerializable diff --git a/ClassReference/api/FastReport.Preview.AddPageAction.html b/ClassReference/api/FastReport.Preview.AddPageAction.html index 1dfbc40..7b8afc0 100644 --- a/ClassReference/api/FastReport.Preview.AddPageAction.html +++ b/ClassReference/api/FastReport.Preview.AddPageAction.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Preview.PreparedPages.html b/ClassReference/api/FastReport.Preview.PreparedPages.html index 755a26a..b845215 100644 --- a/ClassReference/api/FastReport.Preview.PreparedPages.html +++ b/ClassReference/api/FastReport.Preview.PreparedPages.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Preview.html b/ClassReference/api/FastReport.Preview.html index 2a37050..ed69902 100644 --- a/ClassReference/api/FastReport.Preview.html +++ b/ClassReference/api/FastReport.Preview.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.PrintOn.html b/ClassReference/api/FastReport.PrintOn.html index db35b66..3b20d74 100644 --- a/ClassReference/api/FastReport.PrintOn.html +++ b/ClassReference/api/FastReport.PrintOn.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.ProcessAt.html b/ClassReference/api/FastReport.ProcessAt.html index 11118b9..05fb933 100644 --- a/ClassReference/api/FastReport.ProcessAt.html +++ b/ClassReference/api/FastReport.ProcessAt.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.ProgressEventArgs.html b/ClassReference/api/FastReport.ProgressEventArgs.html index 6662431..d7d42f8 100644 --- a/ClassReference/api/FastReport.ProgressEventArgs.html +++ b/ClassReference/api/FastReport.ProgressEventArgs.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.ProgressEventHandler.html b/ClassReference/api/FastReport.ProgressEventHandler.html index f644df1..f19bba6 100644 --- a/ClassReference/api/FastReport.ProgressEventHandler.html +++ b/ClassReference/api/FastReport.ProgressEventHandler.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Report.html b/ClassReference/api/FastReport.Report.html index 887a7e6..80e0970 100644 --- a/ClassReference/api/FastReport.Report.html +++ b/ClassReference/api/FastReport.Report.html @@ -10,7 +10,7 @@ - + @@ -206,21 +206,21 @@
Syntax
public class Report : Base, IFRSerializable, IParent, ISupportInitialize
Remarks
-

The instance of this class contains a report. Here are some common +

The instance of this class contains a report. Here are some common actions that can be performed with this object:

  • To load a report, use the Load(String) method or call static FromFile(String) method.
  • To save a report, call the Save(String) method.
  • To register application dataset for use it in a report, call one of the RegisterData methods.
  • To pass some parameter to a report, use the -SetParameterValue(String, Object) method.
  • To design a report, call the method.
  • To run a report and preview it, call the method. -Another way is to call the Prepare() method, then call the +SetParameterValue(String, Object) method.
  • To design a report, call the method.
  • To run a report and preview it, call the method. +Another way is to call the Prepare() method, then call the method.
  • To run a report and print it, call the method. -Another way is to call the Prepare() method, then call the +Another way is to call the Prepare() method, then call the method.
  • To load/save prepared report, use one of the LoadPrepared and SavePrepared methods.
  • To set up some global properties, use the Config static class or component that you can use in the Visual Studio IDE.
-

The report consists of one or several report pages (pages of the -ReportPage type) and/or dialog forms (pages of the type). +

The report consists of one or several report pages (pages of the +ReportPage type) and/or dialog forms (pages of the type). They are stored in the Pages collection. In turn, each page may contain report objects. See the example below how to create a simple report in code.

@@ -395,7 +395,7 @@
Remarks

ConvertNulls

-

Gets or sets a value indicating whether the null DB value must be converted to zero, false or
+

Gets or sets a value indicating whether the null DB value must be converted to zero, false or empty string depending on the data column type.

@@ -480,8 +480,8 @@
Property Value
Remarks
-

Typically the second pass is necessary to print the number of total pages. It also -may be used to perform some calculations on the first pass and print its results on the +

Typically the second pass is necessary to print the number of total pages. It also +may be used to perform some calculations on the first pass and print its results on the second pass.

Use the Engine.FirstPass, Engine.FinalPass properties to determine which pass the engine is performing now.

@@ -823,11 +823,11 @@
Remarks

Parameters are displayed in the "Data" window under the "Parameters" node.

Typical use of parameters is to pass some static data from the application to the report. You can print such data, use it in the data row filter, script etc.

-

Another way to use parameters is to define some reusable piece of code, for example, -to define an expression that will return the concatenation of first and second employee name. -In this case, you set the parameter's Expression property to something like this: +

Another way to use parameters is to define some reusable piece of code, for example, +to define an expression that will return the concatenation of first and second employee name. +In this case, you set the parameter's Expression property to something like this: [Employees.FirstName] + " " + [Employees.LastName]. Now this parameter may be used in the report -to print full employee name. Each time you access such parameter, it will calculate the expression +to print full employee name. Each time you access such parameter, it will calculate the expression and return its value.

You can create nested parameters. To do this, add the new Parameter to the Parameters collection of the root parameter. To access the nested parameter, you may use the @@ -867,7 +867,7 @@

Remarks

When you try to load the password-protected report, you will be asked for a password. You also may specify the password in this property before loading the report. In this case the report will load silently.

-

Password-protected report file is crypted using Rijndael algorithm. +

Password-protected report file is crypted using Rijndael algorithm. Do not forget your password! It will be hard or even impossible to open the protected file in this case.

@@ -1106,18 +1106,18 @@
Property Value
Remarks

The script contains the ReportScript class that contains all report objects' -event handlers and own items such as private fields, properties, methods etc. The script -contains only items written by you. Unlike other report generators, the script does not -contain report objects declarations, initialization code. It is added automatically when +event handlers and own items such as private fields, properties, methods etc. The script +contains only items written by you. Unlike other report generators, the script does not +contain report objects declarations, initialization code. It is added automatically when you run the report.

-

By default this property contains an empty script text. You may see it in the designer +

By default this property contains an empty script text. You may see it in the designer when you switch to the Code window.

-

If you set this property programmatically, you have to declare the FastReport -namespace and the ReportScript class in it. Do not declare report items (such as bands, -objects, etc) in the ReportScript class: the report engine does this automatically when +

If you set this property programmatically, you have to declare the FastReport +namespace and the ReportScript class in it. Do not declare report items (such as bands, +objects, etc) in the ReportScript class: the report engine does this automatically when you run the report.

-

Security note: since the report script is compiled into .NET assembly, it allows -you to do ANYTHING. For example, you may create a script that will read/write files from/to a disk. +

Security note: since the report script is compiled into .NET assembly, it allows +you to do ANYTHING. For example, you may create a script that will read/write files from/to a disk. To restrict such operations, use the ScriptRestrictions property.

@@ -1304,7 +1304,8 @@
Declaration

AddChild(Base)

-
+

Adds a child object to this object's childs.

+
Declaration
@@ -1345,7 +1346,8 @@
Remarks

Assign(Base)

-
+

Copies the contents of another, similar object.

+
Declaration
@@ -1364,12 +1366,28 @@
Parameters
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(Base) method. +

+
+
See Also
+ @@ -1427,7 +1445,7 @@
Returns
Remarks
-

The expression may be any valid expression such as "1 + 2". The expression +

The expression may be any valid expression such as "1 + 2". The expression is calculated in the report script's ReportScript class instance context, so you may refer to any objects available in this context: private fields, methods, report objects.

@@ -1545,7 +1563,8 @@

CanContain(Base)

-
+

Gets a value indicating that this object can contain the specified child object.

+
Declaration
@@ -1564,7 +1583,8 @@
Parameters
Base child - +

Child object.

+ @@ -1579,7 +1599,8 @@
Returns
System.Boolean - +

true if this object can contain the specified child object; otherwise, false.

+ @@ -1587,7 +1608,8 @@
Returns

Clear()

-
+

Clears the object's state.

+
Declaration
@@ -1595,11 +1617,15 @@
Declaration
Overrides
+
Remarks
+

This method also disposes all object's children.

+

Deserialize(FRReader)

-
+

Deserializes the object.

+
Declaration
@@ -1618,17 +1644,29 @@
Parameters
FRReader reader - +

Reader 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 restore the state. It may + happen when:

+
  • loading the report from a file or stream;
  • loading the report from the designer's undo + buffer;
  • assigning another object to this object using the +Assign(Base) or AssignAll(Base) methods;
  • loading the object from the designer's + clipboard;
+

DeserializeSubItems(FRReader)

-
+

Deserializes nested object properties.

+
Declaration
@@ -1647,12 +1685,23 @@
Parameters
FRReader reader - +

Reader object.

+
Overrides
+
Remarks
+

Typically the object serializes all properties to the single xml item:

+
<TextObject Name="Text2" Left="18.9" Top="37.8" Width="283.5" Height="28.35"/>
+

Some objects like DataBand have child objects that serialized in subitems:

+
<DataBand Name="Data1" Top="163" Width="718.2" Height="18.9">
+  <TextObject Name="Text3" Left="18.9" Top="37.8" Width="283.5" Height="28.35"/>
+</DataBand>
+

To read such subitems, the DeserializeSubItems method is used. Base +implementation reads the child objects. You may override it to read some specific subitems.

+
@@ -1777,7 +1826,8 @@
Parameters

FindObject(String)

-
+

Searches for an object with given name.

+
Declaration
@@ -1796,7 +1846,8 @@
Parameters
System.String name - +

Name of the object to find.

+ @@ -1811,7 +1862,8 @@
Returns
Base - +

Returns a null reference if object is not found

+ @@ -1992,7 +2044,8 @@
Remarks

GetChildObjects(ObjectCollection)

-
+

Gets a list of child objects.

+
Declaration
@@ -2011,7 +2064,8 @@
Parameters
ObjectCollection list - +

List to fill with values.

+ @@ -2019,7 +2073,8 @@
Parameters

GetChildOrder(Base)

-
+

Returns z-order of the specified child object.

+
Declaration
@@ -2038,7 +2093,8 @@
Parameters
Base child - +

Child object.

+ @@ -2053,10 +2109,14 @@
Returns
System.Int32 - +

Z-order of the specified object.

+ +
Remarks
+

This method must return the index of a specified child object in the internal child list.

+
@@ -3365,7 +3425,8 @@

RemoveChild(Base)

-
+

Removes a specified object from this object's childs.

+
Declaration
@@ -3562,7 +3623,8 @@
Returns

Serialize(FRWriter)

-
+

Serializes the object.

+
Declaration
@@ -3581,17 +3643,30 @@
Parameters
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(Base) methods; +
  • saving the object to the designer's clipboard;
  • saving the object to the preview (when run a +report).
+

SetChildOrder(Base, Int32)

-
+

Sets the z-order of the specified object.

+
Declaration
@@ -3610,15 +3685,20 @@
Parameters
Base child - +

Child object.

+ System.Int32 order - +

New Z-order.

+ +
Remarks
+

This method must place the specified child object at the specified position in the internal child list.

+
@@ -3705,7 +3785,8 @@
Parameters

UpdateLayout(Single, Single)

-
+

Updates the children layout when the size of this object is changed by dx, dy values.

+
Declaration
@@ -3724,15 +3805,21 @@
Parameters
System.Single dx - +

X delta.

+ System.Single dy - +

Y delta.

+ +
Remarks
+

This method must update positions/sizes of child objects whose Dock or Anchor properties +are set to non-default values.

+

Events

diff --git a/ClassReference/api/FastReport.ReportComponentBase.html b/ClassReference/api/FastReport.ReportComponentBase.html index 0bdec36..fc02a04 100644 --- a/ClassReference/api/FastReport.ReportComponentBase.html +++ b/ClassReference/api/FastReport.ReportComponentBase.html @@ -10,7 +10,7 @@ - + @@ -87,7 +87,7 @@
Inheritance
- + @@ -150,6 +150,9 @@
Inherited Members
+ @@ -240,9 +243,6 @@
Inherited Members
- @@ -1107,36 +1107,6 @@
Property Value
- -

Printable

-

Gets or sets a value that determines if the object can be printed on the printer.

-
-
-
Declaration
-
-
public bool Printable { get; set; }
-
-
Property Value
- - - - - - - - - - - - - -
TypeDescription
System.Boolean
-
Remarks
-

Object with Printable = false is still visible in the preview window, but not on the prinout. -If you want to hide an object in the preview, set the Visible property to false.

-
- -

PrintOn

Gets or sets a value that determines where to print the object.

@@ -1258,7 +1228,8 @@
Parameters

Assign(Base)

-
+

Copies the contents of another, similar object.

+
Declaration
@@ -1277,12 +1248,28 @@
Parameters
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(Base) method. +

+
+
See Also
+ @@ -1316,6 +1303,35 @@
Remarks
+ +

Deserialize(FRReader)

+
+
+
Declaration
+
+
public override void Deserialize(FRReader reader)
+
+
Parameters
+ + + + + + + + + + + + + + + +
TypeNameDescription
FRReaderreader
+
Overrides
+ + +

Draw(FRPaintEventArgs)

@@ -1404,7 +1420,8 @@
Remarks

GetExpressions()

-
+

Gets all expressions contained in the object.

+
Declaration
@@ -1421,12 +1438,23 @@
Returns
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. +

+
@@ -1544,7 +1572,8 @@
Parameters

OnAfterLoad()

-
+

Called after all report objects were loaded.

+
Declaration
@@ -1552,6 +1581,10 @@
Declaration
Overrides
+
Remarks
+

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

+
@@ -1698,7 +1731,8 @@
Declaration

Serialize(FRWriter)

-
+

Serializes the object.

+
Declaration
@@ -1717,12 +1751,24 @@
Parameters
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(Base) methods; +
  • saving the object to the designer's clipboard;
  • saving the object to the preview (when run a +report).
+

Events

diff --git a/ClassReference/api/FastReport.ReportComponentCollection.html b/ClassReference/api/FastReport.ReportComponentCollection.html index 6716db0..51d273b 100644 --- a/ClassReference/api/FastReport.ReportComponentCollection.html +++ b/ClassReference/api/FastReport.ReportComponentCollection.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.ReportInfo.html b/ClassReference/api/FastReport.ReportInfo.html index 69d5534..32bc3f3 100644 --- a/ClassReference/api/FastReport.ReportInfo.html +++ b/ClassReference/api/FastReport.ReportInfo.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.ReportOperation.html b/ClassReference/api/FastReport.ReportOperation.html index fdb8aaf..429354e 100644 --- a/ClassReference/api/FastReport.ReportOperation.html +++ b/ClassReference/api/FastReport.ReportOperation.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.ReportPage.html b/ClassReference/api/FastReport.ReportPage.html index 4ce5e9c..00157bc 100644 --- a/ClassReference/api/FastReport.ReportPage.html +++ b/ClassReference/api/FastReport.ReportPage.html @@ -10,7 +10,7 @@ - + @@ -148,6 +148,9 @@
Inherited Members
+ @@ -1415,7 +1418,8 @@

Methods

AddChild(Base)

-
+

Adds a child object to this object's childs.

+
Declaration
@@ -1434,7 +1438,8 @@
Parameters
Base child - +

Object to add.

+ @@ -1442,7 +1447,8 @@
Parameters

Assign(Base)

-
+

Copies the contents of another, similar object.

+
Declaration
@@ -1461,17 +1467,34 @@
Parameters
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(Base) method. +

+
+
See Also
+

CanContain(Base)

-
+

Gets a value indicating that this object can contain the specified child object.

+
Declaration
@@ -1490,7 +1513,8 @@
Parameters
Base child - +

Child object.

+ @@ -1505,7 +1529,8 @@
Returns
System.Boolean - +

true if this object can contain the specified child object; otherwise, false.

+ @@ -1569,7 +1594,8 @@
Parameters

ExtractMacros()

-
+

Used to extract macros such as "TotalPages#" in the preview mode.

+
Declaration
@@ -1577,11 +1603,17 @@
Declaration
Overrides
+
Remarks
+

This method is used mainly by the TextObject to extract macros and replace it with +actual values passed in the pageIndex and totalPages parameters. This method +is called automatically when the object is being previewed.

+

GetChildObjects(ObjectCollection)

-
+

Gets a list of child objects.

+
Declaration
@@ -1600,7 +1632,8 @@
Parameters
ObjectCollection list - +

List to fill with values.

+ @@ -1608,7 +1641,8 @@
Parameters

GetChildOrder(Base)

-
+

Returns z-order of the specified child object.

+
Declaration
@@ -1627,7 +1661,8 @@
Parameters
Base child - +

Child object.

+ @@ -1642,15 +1677,20 @@
Returns
System.Int32 - +

Z-order of the specified object.

+ +
Remarks
+

This method must return the index of a specified child object in the internal child list.

+

GetExpressions()

-
+

Gets all expressions contained in the object.

+
Declaration
@@ -1667,12 +1707,23 @@
Returns
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. +

+
@@ -1761,7 +1812,8 @@
Parameters

RemoveChild(Base)

-
+

Removes a specified object from this object's childs.

+
Declaration
@@ -1788,7 +1840,8 @@
Parameters

Serialize(FRWriter)

-
+

Serializes the object.

+
Declaration
@@ -1807,17 +1860,30 @@
Parameters
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(Base) methods; +
  • saving the object to the designer's clipboard;
  • saving the object to the preview (when run a +report).
+

SetChildOrder(Base, Int32)

-
+

Sets the z-order of the specified object.

+
Declaration
@@ -1836,20 +1902,26 @@
Parameters
Base child - +

Child object.

+ System.Int32 order - +

New Z-order.

+ +
Remarks
+

This method must place the specified child object at the specified position in the internal child list.

+

UpdateLayout(Single, Single)

-
+

Updates the children layout when the size of this object is changed by dx, dy values.

+
Declaration
@@ -1868,15 +1940,21 @@
Parameters
System.Single dx - +

X delta.

+ System.Single dy - +

Y delta.

+ +
Remarks
+

This method must update positions/sizes of child objects whose Dock or Anchor properties +are set to non-default values.

+

Events

diff --git a/ClassReference/api/FastReport.ReportSettings.html b/ClassReference/api/FastReport.ReportSettings.html index fde6fa1..3e44625 100644 --- a/ClassReference/api/FastReport.ReportSettings.html +++ b/ClassReference/api/FastReport.ReportSettings.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.ReportSummaryBand.html b/ClassReference/api/FastReport.ReportSummaryBand.html index 39c40f9..c4542f2 100644 --- a/ClassReference/api/FastReport.ReportSummaryBand.html +++ b/ClassReference/api/FastReport.ReportSummaryBand.html @@ -10,7 +10,7 @@ - + @@ -115,6 +115,9 @@
Inherited Members
+ @@ -229,9 +232,6 @@
Inherited Members
- @@ -343,6 +343,9 @@
Inherited Members
+ @@ -409,6 +412,9 @@
Inherited Members
+ @@ -499,9 +505,6 @@
Inherited Members
- diff --git a/ClassReference/api/FastReport.ReportTitleBand.html b/ClassReference/api/FastReport.ReportTitleBand.html index 37bc083..7571e03 100644 --- a/ClassReference/api/FastReport.ReportTitleBand.html +++ b/ClassReference/api/FastReport.ReportTitleBand.html @@ -10,7 +10,7 @@ - + @@ -102,6 +102,9 @@
Inherited Members
+ @@ -222,9 +225,6 @@
Inherited Members
- @@ -336,6 +336,9 @@
Inherited Members
+ @@ -402,6 +405,9 @@
Inherited Members
+ @@ -492,9 +498,6 @@
Inherited Members
- diff --git a/ClassReference/api/FastReport.Restrictions.html b/ClassReference/api/FastReport.Restrictions.html index 1915d78..db7ec87 100644 --- a/ClassReference/api/FastReport.Restrictions.html +++ b/ClassReference/api/FastReport.Restrictions.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.SaveMode.html b/ClassReference/api/FastReport.SaveMode.html index 8c3b830..c5e48d5 100644 --- a/ClassReference/api/FastReport.SaveMode.html +++ b/ClassReference/api/FastReport.SaveMode.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.ShapeKind.html b/ClassReference/api/FastReport.ShapeKind.html index 470f1f2..55f4199 100644 --- a/ClassReference/api/FastReport.ShapeKind.html +++ b/ClassReference/api/FastReport.ShapeKind.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.ShapeObject.html b/ClassReference/api/FastReport.ShapeObject.html index 50a5305..7d2d0a6 100644 --- a/ClassReference/api/FastReport.ShapeObject.html +++ b/ClassReference/api/FastReport.ShapeObject.html @@ -10,7 +10,7 @@ - + @@ -102,9 +102,6 @@
Inherited Members
- @@ -213,6 +210,9 @@
Inherited Members
+ @@ -303,6 +303,9 @@
Inherited Members
+ @@ -393,9 +396,6 @@
Inherited Members
- @@ -516,7 +516,8 @@

Methods

Assign(Base)

-
+

Copies the contents of another, similar object.

+
Declaration
@@ -535,12 +536,28 @@
Parameters
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(Base) method. +

+
+
See Also
+ @@ -574,7 +591,8 @@
Overrides

Serialize(FRWriter)

-
+

Serializes the object.

+
Declaration
@@ -593,12 +611,24 @@
Parameters
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(Base) methods; +
  • saving the object to the designer's clipboard;
  • saving the object to the preview (when run a +report).
+

Implements

IFRSerializable diff --git a/ClassReference/api/FastReport.ShiftMode.html b/ClassReference/api/FastReport.ShiftMode.html index 99b86dd..b4b92eb 100644 --- a/ClassReference/api/FastReport.ShiftMode.html +++ b/ClassReference/api/FastReport.ShiftMode.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.SolidFill.html b/ClassReference/api/FastReport.SolidFill.html index 3b61678..0890b4c 100644 --- a/ClassReference/api/FastReport.SolidFill.html +++ b/ClassReference/api/FastReport.SolidFill.html @@ -10,7 +10,7 @@ - + @@ -84,6 +84,18 @@
Inheritance
Inherited Members
+ + + +
System.Object.ToString()
@@ -181,7 +193,8 @@

Methods

Clone()

-
+

Creates exact copy of this fill.

+
Declaration
@@ -198,7 +211,8 @@
Returns
FillBase - +

Copy of this object.

+ @@ -208,7 +222,8 @@
Overrides

CreateBrush(RectangleF)

-
+

Creates the GDI+ Brush object.

+
Declaration
@@ -227,7 +242,8 @@
Parameters
RectangleF rect - +

Drawing rectangle.

+ @@ -242,7 +258,8 @@
Returns
Brush - +

Brush object.

+ @@ -252,7 +269,8 @@
Overrides

Draw(FRPaintEventArgs, RectangleF)

-
+

Fills the specified rectangle.

+
Declaration
@@ -271,12 +289,14 @@
Parameters
FRPaintEventArgs e - +

Draw event arguments.

+ RectangleF rect - +

Drawing rectangle.

+ @@ -357,7 +377,8 @@
Overrides

Serialize(FRWriter, String, FillBase)

-
+

Serializes the fill.

+
Declaration
@@ -376,22 +397,28 @@
Parameters
FRWriter writer - +

Writer object.

+ System.String prefix - +

Name of the fill property.

+ FillBase fill - +

Fill object to compare with.

+
Overrides
+
Remarks
+

This method is for internal use only.

+
diff --git a/ClassReference/api/FastReport.Sort.html b/ClassReference/api/FastReport.Sort.html index 7c84acf..34adf06 100644 --- a/ClassReference/api/FastReport.Sort.html +++ b/ClassReference/api/FastReport.Sort.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.SortCollection.html b/ClassReference/api/FastReport.SortCollection.html index ca57d05..f94c234 100644 --- a/ClassReference/api/FastReport.SortCollection.html +++ b/ClassReference/api/FastReport.SortCollection.html @@ -10,7 +10,7 @@ - + @@ -406,7 +406,8 @@
Returns

Deserialize(FRReader)

-
+

Deserializes the object.

+
Declaration
@@ -425,7 +426,8 @@
Parameters
FRReader reader - +

Reader object.

+ @@ -543,7 +545,8 @@
Parameters

Serialize(FRWriter)

-
+

Serializes the object.

+
Declaration
@@ -562,7 +565,8 @@
Parameters
FRWriter writer - +

Writer object.

+ diff --git a/ClassReference/api/FastReport.SortOrder.html b/ClassReference/api/FastReport.SortOrder.html index 37f75f6..adaea71 100644 --- a/ClassReference/api/FastReport.SortOrder.html +++ b/ClassReference/api/FastReport.SortOrder.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Style.html b/ClassReference/api/FastReport.Style.html index 00158ff..54212f8 100644 --- a/ClassReference/api/FastReport.Style.html +++ b/ClassReference/api/FastReport.Style.html @@ -10,7 +10,7 @@ - + @@ -204,7 +204,8 @@

Methods

Assign(StyleBase)

-
+

Assigns values from another source.

+
Declaration
@@ -223,7 +224,8 @@
Parameters
StyleBase source - +

Source to assign from.

+ @@ -260,7 +262,8 @@
Returns

Serialize(FRWriter)

-
+

Serializes the style.

+
Declaration
@@ -279,12 +282,16 @@
Parameters
FRWriter writer - +

Writer object.

+
Overrides
+
Remarks
+

This method is for internal use only.

+

Implements

IFRSerializable diff --git a/ClassReference/api/FastReport.StyleBase.html b/ClassReference/api/FastReport.StyleBase.html index 2be8d1f..d842659 100644 --- a/ClassReference/api/FastReport.StyleBase.html +++ b/ClassReference/api/FastReport.StyleBase.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.StyleCollection.html b/ClassReference/api/FastReport.StyleCollection.html index 7176881..dece045 100644 --- a/ClassReference/api/FastReport.StyleCollection.html +++ b/ClassReference/api/FastReport.StyleCollection.html @@ -10,7 +10,7 @@ - + @@ -488,7 +488,8 @@
Returns

Deserialize(FRReader)

-
+

Deserializes the object.

+
Declaration
@@ -507,7 +508,8 @@
Parameters
FRReader reader - +

Reader object.

+ @@ -787,7 +789,8 @@
Parameters

Serialize(FRWriter)

-
+

Serializes the object.

+
Declaration
@@ -806,7 +809,8 @@
Parameters
FRWriter writer - +

Writer object.

+ diff --git a/ClassReference/api/FastReport.StylePriority.html b/ClassReference/api/FastReport.StylePriority.html index 001e020..1f0442c 100644 --- a/ClassReference/api/FastReport.StylePriority.html +++ b/ClassReference/api/FastReport.StylePriority.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.StyleSheet.html b/ClassReference/api/FastReport.StyleSheet.html index 0d0c1ac..1d25fdd 100644 --- a/ClassReference/api/FastReport.StyleSheet.html +++ b/ClassReference/api/FastReport.StyleSheet.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.SubreportObject.html b/ClassReference/api/FastReport.SubreportObject.html index 3a46f4f..b633653 100644 --- a/ClassReference/api/FastReport.SubreportObject.html +++ b/ClassReference/api/FastReport.SubreportObject.html @@ -10,7 +10,7 @@ - + @@ -102,9 +102,6 @@
Inherited Members
- @@ -216,6 +213,9 @@
Inherited Members
+ @@ -306,6 +306,9 @@
Inherited Members
+ @@ -396,9 +399,6 @@
Inherited Members
- @@ -541,7 +541,8 @@

Methods

Assign(Base)

-
+

Copies the contents of another, similar object.

+
Declaration
@@ -560,17 +561,34 @@
Parameters
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(Base) method. +

+
+
See Also
+

Serialize(FRWriter)

-
+

Serializes the object.

+
Declaration
@@ -589,12 +607,24 @@
Parameters
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(Base) methods; +
  • saving the object to the designer's clipboard;
  • saving the object to the preview (when run a +report).
+

Implements

IFRSerializable diff --git a/ClassReference/api/FastReport.Table.TableBase.html b/ClassReference/api/FastReport.Table.TableBase.html index fba455d..235ab13 100644 --- a/ClassReference/api/FastReport.Table.TableBase.html +++ b/ClassReference/api/FastReport.Table.TableBase.html @@ -10,7 +10,7 @@ - + @@ -115,9 +115,6 @@
Inherited Members
- @@ -223,6 +220,9 @@
Inherited Members
+ @@ -304,6 +304,9 @@
Inherited Members
+ @@ -394,9 +397,6 @@
Inherited Members
- @@ -875,7 +875,8 @@

Methods

AddChild(Base)

-
+

Adds a child object to this object's childs.

+
Declaration
@@ -894,7 +895,8 @@
Parameters
Base child - +

Object to add.

+ @@ -902,7 +904,8 @@
Parameters

Assign(Base)

-
+

Copies the contents of another, similar object.

+
Declaration
@@ -921,12 +924,28 @@
Parameters
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(Base) method. +

+
+
See Also
+ @@ -979,7 +998,8 @@
Rema

Break(BreakableComponent)

-
+

Breaks the contents of the object.

+
Declaration
@@ -998,7 +1018,9 @@
Parameters
BreakableComponent breakTo - +

Object to put the part of content to that does not fit in this object. These two +objects must have the same type.

+ @@ -1013,17 +1035,30 @@
Returns
System.Boolean - +

true if there is enough space in this object to display at least one text line.

+
Overrides
+
Remarks
+

+Do not call this method directly, it is used by the report engine. You should override it if +you are writing a new FastReport object. +

+

+This method must break the contents of the object. The part of content that fit in current object's +bounds should remain in this object, the part that does not fit should be transferred to breakTo +object. +

+

CalcHeight()

-
+

Calculates the object's height.

+
Declaration
@@ -1040,12 +1075,17 @@
Returns
System.Single - +

Actual object's height, in pixels.

+
Overrides
+
Remarks
+

Applicable to objects that contain several text lines, such as TextObject. Returns the height needed +to display all the text lines.

+
@@ -1076,7 +1116,8 @@
Returns

CanContain(Base)

-
+

Gets a value indicating that this object can contain the specified child object.

+
Declaration
@@ -1095,7 +1136,8 @@
Parameters
Base child - +

Child object.

+ @@ -1110,7 +1152,8 @@
Returns
System.Boolean - +

true if this object can contain the specified child object; otherwise, false.

+ @@ -1257,7 +1300,8 @@
Returns

GetChildObjects(ObjectCollection)

-
+

Gets a list of child objects.

+
Declaration
@@ -1276,7 +1320,8 @@
Parameters
ObjectCollection list - +

List to fill with values.

+ @@ -1284,7 +1329,8 @@
Parameters

GetChildOrder(Base)

-
+

Returns z-order of the specified child object.

+
Declaration
@@ -1303,7 +1349,8 @@
Parameters
Base child - +

Child object.

+ @@ -1318,6 +1365,52 @@
Returns
System.Int32 +

Z-order of the specified object.

+ + + + +
Remarks
+

This method must return the index of a specified child object in the internal child list.

+
+ + + +

IsInsideSpan(TableCell)

+
+
+
Declaration
+
+
public bool IsInsideSpan(TableCell cell)
+
+
Parameters
+ + + + + + + + + + + + + + + +
TypeNameDescription
TableCellcell
+
Returns
+ + + + + + + + + + @@ -1326,7 +1419,8 @@
Returns

IsVisible(FRPaintEventArgs)

-
+

Determines if the object is visible on current drawing surface.

+
Declaration
@@ -1345,7 +1439,8 @@
Parameters
- +
TypeDescription
System.Boolean
FRPaintEventArgs e

Draw event arguments.

+
@@ -1466,7 +1561,8 @@
Rema

RemoveChild(Base)

-
+

Removes a specified object from this object's childs.

+
Declaration
@@ -1493,7 +1589,8 @@
Parameters

RestoreState()

-
+

Restores the object's state after printing it.

+
Declaration
@@ -1501,11 +1598,17 @@
Declaration
Overrides
+
Remarks
+

This method is called by the report engine after 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 restore the object properties that were saved by the SaveState() method. +

SaveState()

-
+

Saves the object's state before printing it.

+
Declaration
@@ -1513,11 +1616,18 @@
Declaration
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 save any object properties that may be changed during the object printing. +The standard implementation saves the object's bounds, visibility, bookmark and hyperlink. +

Serialize(FRWriter)

-
+

Serializes the object.

+
Declaration
@@ -1536,17 +1646,30 @@
Parameters
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(Base) methods; +
  • saving the object to the designer's clipboard;
  • saving the object to the preview (when run a +report).
+

SetChildOrder(Base, Int32)

-
+

Sets the z-order of the specified object.

+
Declaration
@@ -1565,15 +1688,20 @@
Parameters
Base child - +

Child object.

+ System.Int32 order - +

New Z-order.

+ +
Remarks
+

This method must place the specified child object at the specified position in the internal child list.

+
@@ -1626,7 +1754,8 @@
Rema

UpdateLayout(Single, Single)

-
+

Updates the children layout when the size of this object is changed by dx, dy values.

+
Declaration
@@ -1645,15 +1774,21 @@
Parameters
System.Single dx - +

X delta.

+ System.Single dy - +

Y delta.

+ +
Remarks
+

This method must update positions/sizes of child objects whose Dock or Anchor properties +are set to non-default values.

+

Implements

IFRSerializable diff --git a/ClassReference/api/FastReport.Table.TableCell.html b/ClassReference/api/FastReport.Table.TableCell.html index 1f8f96b..9541105 100644 --- a/ClassReference/api/FastReport.Table.TableCell.html +++ b/ClassReference/api/FastReport.Table.TableCell.html @@ -10,7 +10,7 @@ - + @@ -181,6 +181,9 @@
Inherited Members
+ @@ -199,6 +202,12 @@
Inherited Members
+ + @@ -265,9 +274,6 @@
Inherited Members
- @@ -376,12 +382,6 @@
Inherited Members
- - @@ -433,6 +433,9 @@
Inherited Members
+ @@ -582,7 +585,8 @@

Properties

AbsLeft

-
+

Gets the absolute left coordinate of the object.

+
Declaration
@@ -609,7 +613,8 @@
Overrides

AbsTop

-
+

Gets the absolute top coordinate of the object.

+
Declaration
@@ -794,7 +799,8 @@
Property Value

Text

-
+

Gets or sets the object's text.

+
Declaration
@@ -817,6 +823,11 @@
Property Value
Overrides
+
Remarks
+

Text may contain expressions and data items, for example: "Today is [Date]". +When report is running, all expressions are calculated and replaced with actual +values, so the text would be "Today is 01.01.2008".

+
@@ -851,7 +862,8 @@

Methods

AddChild(Base)

-
+

Adds a child object to this object's childs.

+
Declaration
@@ -870,7 +882,8 @@
Parameters
Base child - +

Object to add.

+ @@ -878,7 +891,8 @@
Parameters

Assign(Base)

-
+

Copies the contents of another, similar object.

+
Declaration
@@ -897,17 +911,34 @@
Parameters
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(Base) method. +

+
+
See Also
+

CanContain(Base)

-
+

Gets a value indicating that this object can contain the specified child object.

+
Declaration
@@ -926,7 +957,8 @@
Parameters
Base child - +

Child object.

+ @@ -941,7 +973,8 @@
Returns
System.Boolean - +

true if this object can contain the specified child object; otherwise, false.

+ @@ -1021,7 +1054,8 @@
Returns

GetChildObjects(ObjectCollection)

-
+

Gets a list of child objects.

+
Declaration
@@ -1040,7 +1074,8 @@
Parameters
ObjectCollection list - +

List to fill with values.

+ @@ -1048,7 +1083,8 @@
Parameters

GetChildOrder(Base)

-
+

Returns z-order of the specified child object.

+
Declaration
@@ -1067,7 +1103,8 @@
Parameters
Base child - +

Child object.

+ @@ -1082,15 +1119,20 @@
Returns
System.Int32 - +

Z-order of the specified object.

+ +
Remarks
+

This method must return the index of a specified child object in the internal child list.

+

GetData()

-
+

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

+
Declaration
@@ -1098,11 +1140,17 @@
Declaration
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. +

GetExpressions()

-
+

Gets all expressions contained in the object.

+
Declaration
@@ -1119,17 +1167,29 @@
Returns
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. +

+

RemoveChild(Base)

-
+

Removes a specified object from this object's childs.

+
Declaration
@@ -1156,7 +1216,8 @@
Parameters

RestoreState()

-
+

Restores the object's state after printing it.

+
Declaration
@@ -1164,11 +1225,17 @@
Declaration
Overrides
+
Remarks
+

This method is called by the report engine after 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 restore the object properties that were saved by the SaveState() method. +

SaveState()

-
+

Saves the object's state before printing it.

+
Declaration
@@ -1176,11 +1243,18 @@
Declaration
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 save any object properties that may be changed during the object printing. +The standard implementation saves the object's bounds, visibility, bookmark and hyperlink. +

Serialize(FRWriter)

-
+

Serializes the object.

+
Declaration
@@ -1199,17 +1273,30 @@
Parameters
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(Base) methods; +
  • saving the object to the designer's clipboard;
  • saving the object to the preview (when run a +report).
+

SetChildOrder(Base, Int32)

-
+

Sets the z-order of the specified object.

+
Declaration
@@ -1228,15 +1315,20 @@
Parameters
Base child - +

Child object.

+ System.Int32 order - +

New Z-order.

+ +
Remarks
+

This method must place the specified child object at the specified position in the internal child list.

+
@@ -1276,7 +1368,8 @@

UpdateLayout(Single, Single)

-
+

Updates the children layout when the size of this object is changed by dx, dy values.

+
Declaration
@@ -1295,15 +1388,21 @@
Parameters
System.Single dx - +

X delta.

+ System.Single dy - +

Y delta.

+ +
Remarks
+

This method must update positions/sizes of child objects whose Dock or Anchor properties +are set to non-default values.

+

Implements

IFRSerializable diff --git a/ClassReference/api/FastReport.Table.TableCellData.html b/ClassReference/api/FastReport.Table.TableCellData.html index 281344a..ea8b025 100644 --- a/ClassReference/api/FastReport.Table.TableCellData.html +++ b/ClassReference/api/FastReport.Table.TableCellData.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Table.TableColumn.html b/ClassReference/api/FastReport.Table.TableColumn.html index ad85994..1524626 100644 --- a/ClassReference/api/FastReport.Table.TableColumn.html +++ b/ClassReference/api/FastReport.Table.TableColumn.html @@ -10,7 +10,7 @@ - + @@ -137,6 +137,9 @@
Inherited Members
+ @@ -377,7 +380,8 @@
Property Value

Left

-
+

Gets or sets the left coordinate of the object in relation to its container.

+
Declaration
@@ -400,6 +404,15 @@
Property Value
Overrides
+
Remarks
+

+ This property value is measured in the screen pixels. Use +Units class to convert a value to desired units. +

+

+ To obtain absolute coordinate, use AbsLeft property. +

+
@@ -518,7 +531,8 @@

Methods

Assign(Base)

-
+

Copies the contents of another, similar object.

+
Declaration
@@ -537,17 +551,34 @@
Parameters
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(Base) method. +

+
+
See Also
+

Clear()

-
+

Clears the object's state.

+
Declaration
@@ -555,11 +586,15 @@
Declaration
Overrides
+
Remarks
+

This method also disposes all object's children.

+

Serialize(FRWriter)

-
+

Serializes the object.

+
Declaration
@@ -578,12 +613,24 @@
Parameters
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(Base) methods; +
  • saving the object to the designer's clipboard;
  • saving the object to the preview (when run a +report).
+

Implements

IFRSerializable diff --git a/ClassReference/api/FastReport.Table.TableColumnCollection.html b/ClassReference/api/FastReport.Table.TableColumnCollection.html index d5e0f65..6e9a7ab 100644 --- a/ClassReference/api/FastReport.Table.TableColumnCollection.html +++ b/ClassReference/api/FastReport.Table.TableColumnCollection.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Table.TableLayout.html b/ClassReference/api/FastReport.Table.TableLayout.html index 09d549f..1bbaca9 100644 --- a/ClassReference/api/FastReport.Table.TableLayout.html +++ b/ClassReference/api/FastReport.Table.TableLayout.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Table.TableObject.html b/ClassReference/api/FastReport.Table.TableObject.html index c80fe20..6e61322 100644 --- a/ClassReference/api/FastReport.Table.TableObject.html +++ b/ClassReference/api/FastReport.Table.TableObject.html @@ -10,7 +10,7 @@ - + @@ -138,6 +138,9 @@
Inherited Members
+ @@ -204,9 +207,6 @@
Inherited Members
- @@ -312,6 +312,9 @@
Inherited Members
+ @@ -390,6 +393,9 @@
Inherited Members
+ @@ -480,9 +486,6 @@
Inherited Members
- @@ -549,7 +552,8 @@

Properties

ColumnCount

-
+

Gets or sets a number of columns in the table.

+
Declaration
@@ -637,7 +641,8 @@
Remarks

RowCount

-
+

Gets or sets a number of rows in the table.

+
Declaration
@@ -666,7 +671,8 @@

Methods

Assign(Base)

-
+

Copies the contents of another, similar object.

+
Declaration
@@ -685,17 +691,34 @@
Parameters
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(Base) method. +

+
+
See Also
+

GetCustomScript()

-
+

Returns a custom code that will be added to the report script before report is run.

+
Declaration
@@ -712,17 +735,28 @@
Returns
System.String - +

A custom script text, if any. Otherwise returns null.

+
Overrides
+
Remarks
+

This method may return any valid code that may be inserted into the report script. Currently it is +used in the TableObject to define the following script methods: Sum, Min, Max, Avg, Count. +

+

+Note: you must take into account the current script language - C# or VB.Net. You may check it via +Report.ScriptLanguage property. +

+

GetData()

-
+

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

+
Declaration
@@ -730,6 +764,11 @@
Declaration
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. +

@@ -935,7 +974,8 @@
Remarks<

RestoreState()

-
+

Restores the object's state after printing it.

+
Declaration
@@ -943,11 +983,17 @@
Declaration
Overrides
+
Remarks
+

This method is called by the report engine after 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 restore the object properties that were saved by the SaveState() method. +

SaveState()

-
+

Saves the object's state before printing it.

+
Declaration
@@ -955,11 +1001,18 @@
Declaration
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 save any object properties that may be changed during the object printing. +The standard implementation saves the object's bounds, visibility, bookmark and hyperlink. +

Serialize(FRWriter)

-
+

Serializes the object.

+
Declaration
@@ -978,12 +1031,24 @@
Parameters
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(Base) methods; +
  • saving the object to the designer's clipboard;
  • saving the object to the preview (when run a +report).
+

Events

diff --git a/ClassReference/api/FastReport.Table.TableResult.html b/ClassReference/api/FastReport.Table.TableResult.html index c6dbd52..2eae19d 100644 --- a/ClassReference/api/FastReport.Table.TableResult.html +++ b/ClassReference/api/FastReport.Table.TableResult.html @@ -10,7 +10,7 @@ - + @@ -147,6 +147,9 @@
Inherited Members
+ @@ -219,9 +222,6 @@
Inherited Members
- @@ -327,6 +327,9 @@
Inherited Members
+ @@ -408,6 +411,9 @@
Inherited Members
+ @@ -495,9 +501,6 @@
Inherited Members
- @@ -590,7 +593,8 @@
Overrides

GetChildObjects(ObjectCollection)

-
+

Gets a list of child objects.

+
Declaration
@@ -609,7 +613,8 @@
Parameters
ObjectCollection list - +

List to fill with values.

+ diff --git a/ClassReference/api/FastReport.Table.TableRow.html b/ClassReference/api/FastReport.Table.TableRow.html index 1866c4c..217fbdc 100644 --- a/ClassReference/api/FastReport.Table.TableRow.html +++ b/ClassReference/api/FastReport.Table.TableRow.html @@ -10,7 +10,7 @@ - + @@ -135,6 +135,9 @@
Inherited Members
+ @@ -535,7 +538,8 @@
Property Value

Top

-
+

Gets or sets the top coordinate of the object in relation to its container.

+
Declaration
@@ -558,13 +562,23 @@
Property Value
Overrides
+
Remarks
+

+ This property value is measured in the screen pixels. Use +Units class to convert a value to desired units. +

+

+ To obtain absolute coordinate, use AbsTop property. +

+

Methods

AddChild(Base)

-
+

Adds a child object to this object's childs.

+
Declaration
@@ -583,7 +597,8 @@
Parameters
Base child - +

Object to add.

+ @@ -591,7 +606,8 @@
Parameters

Assign(Base)

-
+

Copies the contents of another, similar object.

+
Declaration
@@ -610,17 +626,34 @@
Parameters
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(Base) method. +

+
+
See Also
+

CanContain(Base)

-
+

Gets a value indicating that this object can contain the specified child object.

+
Declaration
@@ -639,7 +672,8 @@
Parameters
Base child - +

Child object.

+ @@ -654,7 +688,8 @@
Returns
System.Boolean - +

true if this object can contain the specified child object; otherwise, false.

+ @@ -662,7 +697,8 @@
Returns

Clear()

-
+

Clears the object's state.

+
Declaration
@@ -670,11 +706,15 @@
Declaration
Overrides
+
Remarks
+

This method also disposes all object's children.

+

GetChildObjects(ObjectCollection)

-
+

Gets a list of child objects.

+
Declaration
@@ -693,7 +733,8 @@
Parameters
ObjectCollection list - +

List to fill with values.

+ @@ -701,7 +742,8 @@
Parameters

GetChildOrder(Base)

-
+

Returns z-order of the specified child object.

+
Declaration
@@ -720,7 +762,8 @@
Parameters
Base child - +

Child object.

+ @@ -735,15 +778,20 @@
Returns
System.Int32 - +

Z-order of the specified object.

+ +
Remarks
+

This method must return the index of a specified child object in the internal child list.

+

RemoveChild(Base)

-
+

Removes a specified object from this object's childs.

+
Declaration
@@ -770,7 +818,8 @@
Parameters

Serialize(FRWriter)

-
+

Serializes the object.

+
Declaration
@@ -789,17 +838,30 @@
Parameters
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(Base) methods; +
  • saving the object to the designer's clipboard;
  • saving the object to the preview (when run a +report).
+

SetChildOrder(Base, Int32)

-
+

Sets the z-order of the specified object.

+
Declaration
@@ -818,20 +880,26 @@
Parameters
Base child - +

Child object.

+ System.Int32 order - +

New Z-order.

+ +
Remarks
+

This method must place the specified child object at the specified position in the internal child list.

+

UpdateLayout(Single, Single)

-
+

Updates the children layout when the size of this object is changed by dx, dy values.

+
Declaration
@@ -850,15 +918,21 @@
Parameters
System.Single dx - +

X delta.

+ System.Single dy - +

Y delta.

+ +
Remarks
+

This method must update positions/sizes of child objects whose Dock or Anchor properties +are set to non-default values.

+

Implements

IFRSerializable diff --git a/ClassReference/api/FastReport.Table.TableRowCollection.html b/ClassReference/api/FastReport.Table.TableRowCollection.html index 5376425..f01c772 100644 --- a/ClassReference/api/FastReport.Table.TableRowCollection.html +++ b/ClassReference/api/FastReport.Table.TableRowCollection.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Table.html b/ClassReference/api/FastReport.Table.html index 581a146..5ea057e 100644 --- a/ClassReference/api/FastReport.Table.html +++ b/ClassReference/api/FastReport.Table.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.TextObject.html b/ClassReference/api/FastReport.TextObject.html index bd7fd3a..6066fe6 100644 --- a/ClassReference/api/FastReport.TextObject.html +++ b/ClassReference/api/FastReport.TextObject.html @@ -10,7 +10,7 @@ - + @@ -154,9 +154,6 @@
Inherited Members
- @@ -265,12 +262,6 @@
Inherited Members
- - @@ -331,6 +322,9 @@
Inherited Members
+ @@ -936,7 +930,7 @@
Property Value

ParagraphOffset

-

Gets or sets the paragraph offset, in pixels.

+

Gets or sets the paragraph offset, in pixels. For HtmlParagraph use ParagraphFormat.FirstLineIndent.

Declaration
@@ -1266,7 +1260,8 @@

Methods

ApplyStyle(Style)

-
+

Applies the style settings.

+
Declaration
@@ -1285,7 +1280,8 @@
Parameters
Style style - +

Style to apply.

+ @@ -1295,7 +1291,8 @@
Overrides

Assign(Base)

-
+

Copies the contents of another, similar object.

+
Declaration
@@ -1314,17 +1311,34 @@
Parameters
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(Base) method. +

+
+
See Also
+

Break(BreakableComponent)

-
+

Breaks the contents of the object.

+
Declaration
@@ -1343,7 +1357,9 @@
Parameters
BreakableComponent breakTo - +

Object to put the part of content to that does not fit in this object. These two +objects must have the same type.

+ @@ -1358,17 +1374,30 @@
Returns
System.Boolean - +

true if there is enough space in this object to display at least one text line.

+
Overrides
+
Remarks
+

+Do not call this method directly, it is used by the report engine. You should override it if +you are writing a new FastReport object. +

+

+This method must break the contents of the object. The part of content that fit in current object's +bounds should remain in this object, the part that does not fit should be transferred to breakTo +object. +

+

CalcHeight()

-
+

Calculates the object's height.

+
Declaration
@@ -1385,12 +1414,17 @@
Returns
System.Single - +

Actual object's height, in pixels.

+
Overrides
+
Remarks
+

Applicable to objects that contain several text lines, such as TextObject. Returns the height needed +to display all the text lines.

+
@@ -1446,12 +1480,13 @@
Parameters
Overrides
- +

DeserializeSubItems(FRReader)

-
+

Deserializes nested object properties.

+
Declaration
@@ -1470,12 +1505,23 @@
Parameters
FRReader reader - +

Reader object.

+
Overrides
+
Remarks
+

Typically the object serializes all properties to the single xml item:

+
<TextObject Name="Text2" Left="18.9" Top="37.8" Width="283.5" Height="28.35"/>
+

Some objects like DataBand have child objects that serialized in subitems:

+
<DataBand Name="Data1" Top="163" Width="718.2" Height="18.9">
+  <TextObject Name="Text3" Left="18.9" Top="37.8" Width="283.5" Height="28.35"/>
+</DataBand>
+

To read such subitems, the DeserializeSubItems method is used. Base +implementation reads the child objects. You may override it to read some specific subitems.

+
@@ -1536,9 +1582,22 @@
Parameters
+ +

FinalizeComponent()

+
+
+
Declaration
+
+
public override void FinalizeComponent()
+
+
Overrides
+ + +

GetData()

-
+

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

+
Declaration
@@ -1546,11 +1605,17 @@
Declaration
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. +

GetExpressions()

-
+

Gets all expressions contained in the object.

+
Declaration
@@ -1567,17 +1632,88 @@
Returns
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. +

+
+ + + +

GetStringFormat(GraphicCache, StringFormatFlags)

+
+
+
Declaration
+
+
public StringFormat GetStringFormat(GraphicCache cache, StringFormatFlags flags)
+
+
Parameters
+ + + + + + + + + + + + + + + + + + + + +
TypeNameDescription
GraphicCachecache
StringFormatFlagsflags
+
Returns
+ + + + + + + + + + + + + +
TypeDescription
StringFormat
+ + + +

InitializeComponent()

+
+
+
Declaration
+
+
public override void InitializeComponent()
+
+
Overrides
+

RestoreState()

-
+

Restores the object's state after printing it.

+
Declaration
@@ -1585,11 +1721,17 @@
Declaration
Overrides
+
Remarks
+

This method is called by the report engine after 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 restore the object properties that were saved by the SaveState() method. +

RestoreStyle()

-
+

Restores the current style.

+
Declaration
@@ -1601,7 +1743,8 @@
Overrides

SaveState()

-
+

Saves the object's state before printing it.

+
Declaration
@@ -1609,11 +1752,18 @@
Declaration
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 save any object properties that may be changed during the object printing. +The standard implementation saves the object's bounds, visibility, bookmark and hyperlink. +

SaveStyle()

-
+

Saves the current style.

+
Declaration
@@ -1625,7 +1775,8 @@
Overrides

Serialize(FRWriter)

-
+

Serializes the object.

+
Declaration
@@ -1644,12 +1795,24 @@
Parameters
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(Base) methods; +
  • saving the object to the designer's clipboard;
  • saving the object to the preview (when run a +report).
+

Implements

IFRSerializable diff --git a/ClassReference/api/FastReport.TextObjectBase.html b/ClassReference/api/FastReport.TextObjectBase.html index e922c13..5445520 100644 --- a/ClassReference/api/FastReport.TextObjectBase.html +++ b/ClassReference/api/FastReport.TextObjectBase.html @@ -10,7 +10,7 @@ - + @@ -114,9 +114,6 @@
Inherited Members
- @@ -228,6 +225,9 @@
Inherited Members
+ @@ -318,6 +318,9 @@
Inherited Members
+ @@ -405,9 +408,6 @@
Inherited Members
- @@ -859,7 +859,8 @@

Methods

Assign(Base)

-
+

Copies the contents of another, similar object.

+
Declaration
@@ -878,17 +879,34 @@
Parameters
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(Base) method. +

+
+
See Also
+

DeserializeSubItems(FRReader)

-
+

Deserializes nested object properties.

+
Declaration
@@ -907,17 +925,29 @@
Parameters
FRReader reader - +

Reader object.

+
Overrides
+
Remarks
+

Typically the object serializes all properties to the single xml item:

+
<TextObject Name="Text2" Left="18.9" Top="37.8" Width="283.5" Height="28.35"/>
+

Some objects like DataBand have child objects that serialized in subitems:

+
<DataBand Name="Data1" Top="163" Width="718.2" Height="18.9">
+  <TextObject Name="Text3" Left="18.9" Top="37.8" Width="283.5" Height="28.35"/>
+</DataBand>
+

To read such subitems, the DeserializeSubItems method is used. Base +implementation reads the child objects. You may override it to read some specific subitems.

+

ExtractMacros()

-
+

Used to extract macros such as "TotalPages#" in the preview mode.

+
Declaration
@@ -925,11 +955,17 @@
Declaration
Overrides
+
Remarks
+

This method is used mainly by the TextObject to extract macros and replace it with +actual values passed in the pageIndex and totalPages parameters. This method +is called automatically when the object is being previewed.

+

Serialize(FRWriter)

-
+

Serializes the object.

+
Declaration
@@ -948,12 +984,24 @@
Parameters
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(Base) methods; +
  • saving the object to the designer's clipboard;
  • saving the object to the preview (when run a +report).
+

Implements

IFRSerializable diff --git a/ClassReference/api/FastReport.TextOutline.html b/ClassReference/api/FastReport.TextOutline.html index 501cbec..6401456 100644 --- a/ClassReference/api/FastReport.TextOutline.html +++ b/ClassReference/api/FastReport.TextOutline.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.TextQuality.html b/ClassReference/api/FastReport.TextQuality.html index 8309c77..c71a560 100644 --- a/ClassReference/api/FastReport.TextQuality.html +++ b/ClassReference/api/FastReport.TextQuality.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.TextRenderType.html b/ClassReference/api/FastReport.TextRenderType.html index c84f838..8a4a9fe 100644 --- a/ClassReference/api/FastReport.TextRenderType.html +++ b/ClassReference/api/FastReport.TextRenderType.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.TextureFill.html b/ClassReference/api/FastReport.TextureFill.html new file mode 100644 index 0000000..ae867fb --- /dev/null +++ b/ClassReference/api/FastReport.TextureFill.html @@ -0,0 +1,860 @@ + + + + + + + + Class TextureFill + | FastReport OpenSource Class Reference + + + + + + + + + + + + + + + +
+
+ + + + +
+ + + +
+ + + + + + diff --git a/ClassReference/api/FastReport.TypeConverters.ComponentRefConverter.html b/ClassReference/api/FastReport.TypeConverters.ComponentRefConverter.html index 9f6006c..f68a0fc 100644 --- a/ClassReference/api/FastReport.TypeConverters.ComponentRefConverter.html +++ b/ClassReference/api/FastReport.TypeConverters.ComponentRefConverter.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.TypeConverters.DataTypeConverter.html b/ClassReference/api/FastReport.TypeConverters.DataTypeConverter.html index 0eef967..c4c44d4 100644 --- a/ClassReference/api/FastReport.TypeConverters.DataTypeConverter.html +++ b/ClassReference/api/FastReport.TypeConverters.DataTypeConverter.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.TypeConverters.FRExpandableObjectConverter.html b/ClassReference/api/FastReport.TypeConverters.FRExpandableObjectConverter.html index 1b20cf0..1e9aabe 100644 --- a/ClassReference/api/FastReport.TypeConverters.FRExpandableObjectConverter.html +++ b/ClassReference/api/FastReport.TypeConverters.FRExpandableObjectConverter.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.TypeConverters.html b/ClassReference/api/FastReport.TypeConverters.html index c4e8ae5..b6dd888 100644 --- a/ClassReference/api/FastReport.TypeConverters.html +++ b/ClassReference/api/FastReport.TypeConverters.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.UncheckedSymbol.html b/ClassReference/api/FastReport.UncheckedSymbol.html index 4cb75ff..ef42f49 100644 --- a/ClassReference/api/FastReport.UncheckedSymbol.html +++ b/ClassReference/api/FastReport.UncheckedSymbol.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Utils.AdvancedTextRenderer.BaseLine.html b/ClassReference/api/FastReport.Utils.AdvancedTextRenderer.BaseLine.html new file mode 100644 index 0000000..af76fc1 --- /dev/null +++ b/ClassReference/api/FastReport.Utils.AdvancedTextRenderer.BaseLine.html @@ -0,0 +1,144 @@ + + + + + + + + Enum AdvancedTextRenderer.BaseLine + | FastReport OpenSource Class Reference + + + + + + + + + + + + + + + +
+
+ + + + +
+ + + +
+ + + + + + diff --git a/ClassReference/api/FastReport.Utils.AdvancedTextRenderer.Line.html b/ClassReference/api/FastReport.Utils.AdvancedTextRenderer.Line.html new file mode 100644 index 0000000..cad8452 --- /dev/null +++ b/ClassReference/api/FastReport.Utils.AdvancedTextRenderer.Line.html @@ -0,0 +1,566 @@ + + + + + + + + Class AdvancedTextRenderer.Line + | FastReport OpenSource Class Reference + + + + + + + + + + + + + + + +
+
+ + + + +
+ + + +
+ + + + + + diff --git a/ClassReference/api/FastReport.Utils.AdvancedTextRenderer.Paragraph.html b/ClassReference/api/FastReport.Utils.AdvancedTextRenderer.Paragraph.html new file mode 100644 index 0000000..169913c --- /dev/null +++ b/ClassReference/api/FastReport.Utils.AdvancedTextRenderer.Paragraph.html @@ -0,0 +1,406 @@ + + + + + + + + Class AdvancedTextRenderer.Paragraph + | FastReport OpenSource Class Reference + + + + + + + + + + + + + + + +
+
+ + + + +
+ + + +
+ + + + + + diff --git a/ClassReference/api/FastReport.Utils.AdvancedTextRenderer.Run.html b/ClassReference/api/FastReport.Utils.AdvancedTextRenderer.Run.html new file mode 100644 index 0000000..e9c43f1 --- /dev/null +++ b/ClassReference/api/FastReport.Utils.AdvancedTextRenderer.Run.html @@ -0,0 +1,722 @@ + + + + + + + + Class AdvancedTextRenderer.Run + | FastReport OpenSource Class Reference + + + + + + + + + + + + + + + +
+
+ + + + +
+ + + +
+ + + + + + diff --git a/ClassReference/api/FastReport.Utils.AdvancedTextRenderer.StyleDescriptor.html b/ClassReference/api/FastReport.Utils.AdvancedTextRenderer.StyleDescriptor.html new file mode 100644 index 0000000..3a83a97 --- /dev/null +++ b/ClassReference/api/FastReport.Utils.AdvancedTextRenderer.StyleDescriptor.html @@ -0,0 +1,341 @@ + + + + + + + + Class AdvancedTextRenderer.StyleDescriptor + | FastReport OpenSource Class Reference + + + + + + + + + + + + + + + +
+
+ + + + +
+ + + +
+ + + + + + diff --git a/ClassReference/api/FastReport.Utils.AdvancedTextRenderer.Word.html b/ClassReference/api/FastReport.Utils.AdvancedTextRenderer.Word.html new file mode 100644 index 0000000..3beceb9 --- /dev/null +++ b/ClassReference/api/FastReport.Utils.AdvancedTextRenderer.Word.html @@ -0,0 +1,436 @@ + + + + + + + + Class AdvancedTextRenderer.Word + | FastReport OpenSource Class Reference + + + + + + + + + + + + + + + +
+
+ + + + +
+ + + +
+ + + + + + diff --git a/ClassReference/api/FastReport.Utils.AdvancedTextRenderer.html b/ClassReference/api/FastReport.Utils.AdvancedTextRenderer.html new file mode 100644 index 0000000..37675a6 --- /dev/null +++ b/ClassReference/api/FastReport.Utils.AdvancedTextRenderer.html @@ -0,0 +1,1038 @@ + + + + + + + + Class AdvancedTextRenderer + | FastReport OpenSource Class Reference + + + + + + + + + + + + + + + +
+
+ + + + +
+ + + +
+ + + + + + diff --git a/ClassReference/api/FastReport.Utils.AncestorException.html b/ClassReference/api/FastReport.Utils.AncestorException.html index 4b50bfe..b810f11 100644 --- a/ClassReference/api/FastReport.Utils.AncestorException.html +++ b/ClassReference/api/FastReport.Utils.AncestorException.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Utils.AssemblyInitializerBase.html b/ClassReference/api/FastReport.Utils.AssemblyInitializerBase.html index 1081f13..23bcccd 100644 --- a/ClassReference/api/FastReport.Utils.AssemblyInitializerBase.html +++ b/ClassReference/api/FastReport.Utils.AssemblyInitializerBase.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Utils.ClassException.html b/ClassReference/api/FastReport.Utils.ClassException.html index dae6812..f03ea04 100644 --- a/ClassReference/api/FastReport.Utils.ClassException.html +++ b/ClassReference/api/FastReport.Utils.ClassException.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Utils.CloudStorageException.html b/ClassReference/api/FastReport.Utils.CloudStorageException.html index 49d69be..02fe292 100644 --- a/ClassReference/api/FastReport.Utils.CloudStorageException.html +++ b/ClassReference/api/FastReport.Utils.CloudStorageException.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Utils.CompileHelper.html b/ClassReference/api/FastReport.Utils.CompileHelper.html new file mode 100644 index 0000000..eba32a2 --- /dev/null +++ b/ClassReference/api/FastReport.Utils.CompileHelper.html @@ -0,0 +1,199 @@ + + + + + + + + Class CompileHelper + | FastReport OpenSource Class Reference + + + + + + + + + + + + + + + +
+
+ + + + +
+ + + +
+ + + + + + diff --git a/ClassReference/api/FastReport.Utils.CompilerException.html b/ClassReference/api/FastReport.Utils.CompilerException.html index edd30c7..85e53f5 100644 --- a/ClassReference/api/FastReport.Utils.CompilerException.html +++ b/ClassReference/api/FastReport.Utils.CompilerException.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Utils.Config.html b/ClassReference/api/FastReport.Utils.Config.html index 234f2ea..aa8f48e 100644 --- a/ClassReference/api/FastReport.Utils.Config.html +++ b/ClassReference/api/FastReport.Utils.Config.html @@ -10,7 +10,7 @@ - + @@ -225,6 +225,36 @@
Remarks
+ +

FontListFolder

+

Gets or sets the path used to font.list file.

+
+
+
Declaration
+
+
public static string FontListFolder { get; set; }
+
+
Property Value
+ + + + + + + + + + + + + +
TypeDescription
System.String
+
Remarks
+

By default, the font.list file is saved to the FastReport.config folder +If WebMode enabled (or config file path is null), then file is saved in the application folder.

+
+ +

IsStringOptimization

Gets or sets the optimization of strings. Is experimental feature.

@@ -355,6 +385,32 @@
Property Value
+ +

SystemTempFolder

+

Gets the path to the system temporary folder used to store temporary files.

+
+
+
Declaration
+
+
public static string SystemTempFolder { get; }
+
+
Property Value
+ + + + + + + + + + + + + +
TypeDescription
System.String
+ +

TempFolder

Gets or sets the path to the temporary folder used to store temporary files.

diff --git a/ClassReference/api/FastReport.Utils.Converter.html b/ClassReference/api/FastReport.Utils.Converter.html index 0be307c..a0aa390 100644 --- a/ClassReference/api/FastReport.Utils.Converter.html +++ b/ClassReference/api/FastReport.Utils.Converter.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Utils.Crypter.html b/ClassReference/api/FastReport.Utils.Crypter.html index 3103f1a..2b18c38 100644 --- a/ClassReference/api/FastReport.Utils.Crypter.html +++ b/ClassReference/api/FastReport.Utils.Crypter.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Utils.DataNotInitializedException.html b/ClassReference/api/FastReport.Utils.DataNotInitializedException.html index 0a5bf32..82ac481 100644 --- a/ClassReference/api/FastReport.Utils.DataNotInitializedException.html +++ b/ClassReference/api/FastReport.Utils.DataNotInitializedException.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Utils.DataTableException.html b/ClassReference/api/FastReport.Utils.DataTableException.html index 3818228..9a3c77f 100644 --- a/ClassReference/api/FastReport.Utils.DataTableException.html +++ b/ClassReference/api/FastReport.Utils.DataTableException.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Utils.DecryptException.html b/ClassReference/api/FastReport.Utils.DecryptException.html index c3fd23a..e773b71 100644 --- a/ClassReference/api/FastReport.Utils.DecryptException.html +++ b/ClassReference/api/FastReport.Utils.DecryptException.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Utils.DrawUtils.html b/ClassReference/api/FastReport.Utils.DrawUtils.html new file mode 100644 index 0000000..8ad5725 --- /dev/null +++ b/ClassReference/api/FastReport.Utils.DrawUtils.html @@ -0,0 +1,654 @@ + + + + + + + + Class DrawUtils + | FastReport OpenSource Class Reference + + + + + + + + + + + + + + + +
+
+ + + + +
+ + + +
+ + + + + + diff --git a/ClassReference/api/FastReport.Utils.DuplicateNameException.html b/ClassReference/api/FastReport.Utils.DuplicateNameException.html index ecd1056..803ee03 100644 --- a/ClassReference/api/FastReport.Utils.DuplicateNameException.html +++ b/ClassReference/api/FastReport.Utils.DuplicateNameException.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Utils.FRCollectionBase.html b/ClassReference/api/FastReport.Utils.FRCollectionBase.html index dac879c..e329f27 100644 --- a/ClassReference/api/FastReport.Utils.FRCollectionBase.html +++ b/ClassReference/api/FastReport.Utils.FRCollectionBase.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Utils.FRPaintEventArgs.html b/ClassReference/api/FastReport.Utils.FRPaintEventArgs.html index af754b8..059d017 100644 --- a/ClassReference/api/FastReport.Utils.FRPaintEventArgs.html +++ b/ClassReference/api/FastReport.Utils.FRPaintEventArgs.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Utils.FRReader.html b/ClassReference/api/FastReport.Utils.FRReader.html index f0ab23b..5f14228 100644 --- a/ClassReference/api/FastReport.Utils.FRReader.html +++ b/ClassReference/api/FastReport.Utils.FRReader.html @@ -10,7 +10,7 @@ - + @@ -186,6 +186,32 @@

Properties

+ +

DeserializeFrom

+

Gets or sets target of serialization.

+
+
+
Declaration
+
+
public SerializeTo DeserializeFrom { get; set; }
+
+
Property Value
+ + + + + + + + + + + + + +
TypeDescription
SerializeTo
+ +

Errors

Gets a string that contains errors occured during the load.

@@ -262,6 +288,32 @@
Property Value
+ + + +

Root

+

Returns Root element for this reader

+
+
+
Declaration
+
+
public XmlItem Root { get; }
+
+
Property Value
+ + + + + + + + + + + + + +
TypeDescription
XmlItem

Methods

diff --git a/ClassReference/api/FastReport.Utils.FRWriter.html b/ClassReference/api/FastReport.Utils.FRWriter.html index 4e235ac..3a20d4a 100644 --- a/ClassReference/api/FastReport.Utils.FRWriter.html +++ b/ClassReference/api/FastReport.Utils.FRWriter.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Utils.FastNameCreator.html b/ClassReference/api/FastReport.Utils.FastNameCreator.html index c7297f9..7194326 100644 --- a/ClassReference/api/FastReport.Utils.FastNameCreator.html +++ b/ClassReference/api/FastReport.Utils.FastNameCreator.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Utils.FastString.html b/ClassReference/api/FastReport.Utils.FastString.html index 3905b21..441c32c 100644 --- a/ClassReference/api/FastReport.Utils.FastString.html +++ b/ClassReference/api/FastReport.Utils.FastString.html @@ -10,7 +10,7 @@ - + @@ -131,7 +131,7 @@

Declaration
-
public FastString(int iniCapacity)
+
public FastString(int initCapacity)
Parameters
@@ -145,7 +145,7 @@
Parameters
- + diff --git a/ClassReference/api/FastReport.Utils.FastStringWithPool.html b/ClassReference/api/FastReport.Utils.FastStringWithPool.html index 1591765..c36201a 100644 --- a/ClassReference/api/FastReport.Utils.FastStringWithPool.html +++ b/ClassReference/api/FastReport.Utils.FastStringWithPool.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Utils.FileFormatException.html b/ClassReference/api/FastReport.Utils.FileFormatException.html index b58a4e6..1875511 100644 --- a/ClassReference/api/FastReport.Utils.FileFormatException.html +++ b/ClassReference/api/FastReport.Utils.FileFormatException.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Utils.FloatCollection.html b/ClassReference/api/FastReport.Utils.FloatCollection.html index c448581..93bc490 100644 --- a/ClassReference/api/FastReport.Utils.FloatCollection.html +++ b/ClassReference/api/FastReport.Utils.FloatCollection.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Utils.GroupHeaderHasNoGroupCondition.html b/ClassReference/api/FastReport.Utils.GroupHeaderHasNoGroupCondition.html new file mode 100644 index 0000000..1b22945 --- /dev/null +++ b/ClassReference/api/FastReport.Utils.GroupHeaderHasNoGroupCondition.html @@ -0,0 +1,195 @@ + + + + + + + + Class GroupHeaderHasNoGroupCondition + | FastReport OpenSource Class Reference + + + + + + + + + + + + + + + +
+
+ + + + +
+ + + +
+ + + + + + diff --git a/ClassReference/api/FastReport.Utils.IGraphicsRenderer.html b/ClassReference/api/FastReport.Utils.IGraphicsRenderer.html new file mode 100644 index 0000000..30ea60a --- /dev/null +++ b/ClassReference/api/FastReport.Utils.IGraphicsRenderer.html @@ -0,0 +1,667 @@ + + + + + + + + Interface IGraphicsRenderer + | FastReport OpenSource Class Reference + + + + + + + + + + + + + + + +
+
+ + + + +
+
System.Int32iniCapacityinitCapacity

Initial capacity.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescription
Penpen
System.Singleleft
System.Singletop
System.Singlewidth
System.Singleheight
+ + + +

DrawLine(Pen, Single, Single, Single, Single)

+
+
+
Declaration
+
+
void DrawLine(Pen pen, float x1, float y1, float x2, float y2)
+
+
Parameters
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescription
Penpen
System.Singlex1
System.Singley1
System.Singlex2
System.Singley2
+ + + +

DrawString(String, Font, Brush, RectangleF)

+
+
+
Declaration
+
+
void DrawString(string text, Font drawFont, Brush brush, RectangleF rectangleF)
+
+
Parameters
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescription
System.Stringtext
FontdrawFont
Brushbrush
RectangleFrectangleF
+ + + +

DrawString(String, Font, Brush, Single, Single)

+
+
+
Declaration
+
+
void DrawString(string text, Font drawFont, Brush brush, float left, float top)
+
+
Parameters
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescription
System.Stringtext
FontdrawFont
Brushbrush
System.Singleleft
System.Singletop
+ + + +

DrawString(String, Font, Brush, Single, Single, Single)

+

in this case if a baseline is needed, it will not be calculated

+
+
+
Declaration
+
+
void DrawString(string text, Font drawFont, Brush brush, float left, float top, float baseLine)
+
+
Parameters
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescription
System.Stringtext
FontdrawFont
Brushbrush
System.Singleleft
System.Singletop
System.SinglebaseLine
+ + + +

FillPath(Brush, GraphicsPath)

+

Works with polygons only

+
+
+
Declaration
+
+
void FillPath(Brush brush, GraphicsPath path)
+
+
Parameters
+ + + + + + + + + + + + + + + + + + + + +
TypeNameDescription
Brushbrush
GraphicsPathpath
+ + + +

FillPolygon(Brush, PointF[])

+
+
+
Declaration
+
+
void FillPolygon(Brush brush, PointF[] points)
+
+
Parameters
+ + + + + + + + + + + + + + + + + + + + +
TypeNameDescription
Brushbrush
PointF[]points
+ + + +

FillRectangle(Brush, Single, Single, Single, Single)

+
+
+
Declaration
+
+
void FillRectangle(Brush brush, float left, float top, float width, float height)
+
+
Parameters
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescription
Brushbrush
System.Singleleft
System.Singletop
System.Singlewidth
System.Singleheight
+ + + +

MeasureString(String, Font)

+
+
+
Declaration
+
+
SizeF MeasureString(string text, Font drawFont)
+
+
Parameters
+ + + + + + + + + + + + + + + + + + + + +
TypeNameDescription
System.Stringtext
FontdrawFont
+
Returns
+ + + + + + + + + + + + + +
TypeDescription
SizeF
+ + + +

PathAddRectangle(GraphicsPath, RectangleF)

+

Add rectangle to the graphics path

+
+
+
Declaration
+
+
void PathAddRectangle(GraphicsPath path, RectangleF rect)
+
+
Parameters
+ + + + + + + + + + + + + + + + + + + + +
TypeNameDescription
GraphicsPathpath
RectangleFrect
+ + + +

Restore(IGraphicsRendererState)

+
+
+
Declaration
+
+
void Restore(IGraphicsRendererState state)
+
+
Parameters
+ + + + + + + + + + + + + + + +
TypeNameDescription
IGraphicsRendererStatestate
+ + + +

RotateTransform(Single)

+
+
+
Declaration
+
+
void RotateTransform(float angle)
+
+
Parameters
+ + + + + + + + + + + + + + + +
TypeNameDescription
System.Singleangle
+ + + +

Save()

+
+
+
Declaration
+
+
IGraphicsRendererState Save()
+
+
Returns
+ + + + + + + + + + + + + +
TypeDescription
IGraphicsRendererState
+ + + +

TranslateTransform(Single, Single)

+
+
+
Declaration
+
+
void TranslateTransform(float left, float top)
+
+
Parameters
+ + + + + + + + + + + + + + + + + + + + +
TypeNameDescription
System.Singleleft
System.Singletop
+ +
+ + +
+
+ + +
+ + + + + + diff --git a/ClassReference/api/FastReport.Utils.IGraphicsRendererState.html b/ClassReference/api/FastReport.Utils.IGraphicsRendererState.html new file mode 100644 index 0000000..7f2c232 --- /dev/null +++ b/ClassReference/api/FastReport.Utils.IGraphicsRendererState.html @@ -0,0 +1,120 @@ + + + + + + + + Interface IGraphicsRendererState + | FastReport OpenSource Class Reference + + + + + + + + + + + + + + + +
+
+ + + + +
+ + + +
+ + + + + + diff --git a/ClassReference/api/FastReport.Utils.InlineImageCache.CacheItem.html b/ClassReference/api/FastReport.Utils.InlineImageCache.CacheItem.html index 6a8dc77..416b882 100644 --- a/ClassReference/api/FastReport.Utils.InlineImageCache.CacheItem.html +++ b/ClassReference/api/FastReport.Utils.InlineImageCache.CacheItem.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Utils.InlineImageCache.LoadEventArgs.html b/ClassReference/api/FastReport.Utils.InlineImageCache.LoadEventArgs.html index 14738fc..771b9ec 100644 --- a/ClassReference/api/FastReport.Utils.InlineImageCache.LoadEventArgs.html +++ b/ClassReference/api/FastReport.Utils.InlineImageCache.LoadEventArgs.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Utils.InlineImageCache.html b/ClassReference/api/FastReport.Utils.InlineImageCache.html index 63f4bdf..8ba966b 100644 --- a/ClassReference/api/FastReport.Utils.InlineImageCache.html +++ b/ClassReference/api/FastReport.Utils.InlineImageCache.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Utils.MatrixValueException.html b/ClassReference/api/FastReport.Utils.MatrixValueException.html index d447675..ceb1525 100644 --- a/ClassReference/api/FastReport.Utils.MatrixValueException.html +++ b/ClassReference/api/FastReport.Utils.MatrixValueException.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Utils.Murmur3.html b/ClassReference/api/FastReport.Utils.Murmur3.html index eb684d3..e20c58a 100644 --- a/ClassReference/api/FastReport.Utils.Murmur3.html +++ b/ClassReference/api/FastReport.Utils.Murmur3.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Utils.MyRes.html b/ClassReference/api/FastReport.Utils.MyRes.html index 075c572..46d2e4d 100644 --- a/ClassReference/api/FastReport.Utils.MyRes.html +++ b/ClassReference/api/FastReport.Utils.MyRes.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Utils.NotValidIdentifierException.html b/ClassReference/api/FastReport.Utils.NotValidIdentifierException.html index 5b6ec24..a109641 100644 --- a/ClassReference/api/FastReport.Utils.NotValidIdentifierException.html +++ b/ClassReference/api/FastReport.Utils.NotValidIdentifierException.html @@ -10,7 +10,7 @@ - + @@ -73,7 +73,7 @@

Class NotValidIdentifierException

-

The exception that is thrown if an error occurs in the MatrixObject.ManualBuild event.

+

The exception that is thrown if a report object's Name property is set to wrong value.

diff --git a/ClassReference/api/FastReport.Utils.ObjectInfo.html b/ClassReference/api/FastReport.Utils.ObjectInfo.html index d59c6d1..5f37ad1 100644 --- a/ClassReference/api/FastReport.Utils.ObjectInfo.html +++ b/ClassReference/api/FastReport.Utils.ObjectInfo.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Utils.PageUnits.html b/ClassReference/api/FastReport.Utils.PageUnits.html index b19705a..8db87ce 100644 --- a/ClassReference/api/FastReport.Utils.PageUnits.html +++ b/ClassReference/api/FastReport.Utils.PageUnits.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Utils.ParentException.html b/ClassReference/api/FastReport.Utils.ParentException.html index 5600848..b63841d 100644 --- a/ClassReference/api/FastReport.Utils.ParentException.html +++ b/ClassReference/api/FastReport.Utils.ParentException.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Utils.RegisteredObjects.html b/ClassReference/api/FastReport.Utils.RegisteredObjects.html index 9a9124c..8f13619 100644 --- a/ClassReference/api/FastReport.Utils.RegisteredObjects.html +++ b/ClassReference/api/FastReport.Utils.RegisteredObjects.html @@ -10,7 +10,7 @@ - + @@ -384,6 +384,53 @@
Parameters
+ +

Add(Type, String, Int32, Int32)

+

Registers an object in the specified category.

+
+
+
Declaration
+
+
public static void Add(Type obj, string category, int imageIndex, int buttonIndex)
+
+
Parameters
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescription
System.Typeobj

Type of object to register.

+
System.Stringcategory

Name of category to register in.

+
System.Int32imageIndex

Index of image for object's button.

+
System.Int32buttonIndex

Index of object's button in toolbar.

+
+ +

AddCategory(String, Bitmap, String)

Registers a category that may contain several report objects.

@@ -595,6 +642,48 @@
Parameters
+ +

AddExport(Type, String, String, Bitmap)

+
+
+
Declaration
+
+
public static void AddExport(Type obj, string category, string text, Bitmap image)
+
+
Parameters
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescription
System.Typeobj
System.Stringcategory
System.Stringtext
Bitmapimage
+ +

AddExportCategory(String, String)

Register Export category.

diff --git a/ClassReference/api/FastReport.Utils.Res.html b/ClassReference/api/FastReport.Utils.Res.html index b1e970a..ec00158 100644 --- a/ClassReference/api/FastReport.Utils.Res.html +++ b/ClassReference/api/FastReport.Utils.Res.html @@ -10,7 +10,7 @@ - + @@ -174,6 +174,38 @@

Methods

+ +

CopyTo(Stream, Stream)

+
+
+
Declaration
+
+
public static void CopyTo(Stream input, Stream output)
+
+
Parameters
+ + + + + + + + + + + + + + + + + + + + +
TypeNameDescription
System.IO.Streaminput
System.IO.Streamoutput
+ +

Get(String)

Gets a string with specified ID.

diff --git a/ClassReference/api/FastReport.Utils.ResourceLoader.html b/ClassReference/api/FastReport.Utils.ResourceLoader.html index a99bf4e..74cb6f5 100644 --- a/ClassReference/api/FastReport.Utils.ResourceLoader.html +++ b/ClassReference/api/FastReport.Utils.ResourceLoader.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Utils.SRCategory.html b/ClassReference/api/FastReport.Utils.SRCategory.html index f242ab4..b9d29fc 100644 --- a/ClassReference/api/FastReport.Utils.SRCategory.html +++ b/ClassReference/api/FastReport.Utils.SRCategory.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Utils.SerializeTo.html b/ClassReference/api/FastReport.Utils.SerializeTo.html index 5215eb9..65b7dea 100644 --- a/ClassReference/api/FastReport.Utils.SerializeTo.html +++ b/ClassReference/api/FastReport.Utils.SerializeTo.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Utils.TableManualBuildException.html b/ClassReference/api/FastReport.Utils.TableManualBuildException.html index 6f813e5..c3922b8 100644 --- a/ClassReference/api/FastReport.Utils.TableManualBuildException.html +++ b/ClassReference/api/FastReport.Utils.TableManualBuildException.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Utils.Units.html b/ClassReference/api/FastReport.Utils.Units.html index ba3a3bc..0a18bba 100644 --- a/ClassReference/api/FastReport.Utils.Units.html +++ b/ClassReference/api/FastReport.Utils.Units.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Utils.UnknownNameException.html b/ClassReference/api/FastReport.Utils.UnknownNameException.html new file mode 100644 index 0000000..d9d0425 --- /dev/null +++ b/ClassReference/api/FastReport.Utils.UnknownNameException.html @@ -0,0 +1,195 @@ + + + + + + + + Class UnknownNameException + | FastReport OpenSource Class Reference + + + + + + + + + + + + + + + +
+
+ + + + +
+ + + +
+ + + + + + diff --git a/ClassReference/api/FastReport.Utils.XmlDocument.html b/ClassReference/api/FastReport.Utils.XmlDocument.html index d29eae1..c1dfdac 100644 --- a/ClassReference/api/FastReport.Utils.XmlDocument.html +++ b/ClassReference/api/FastReport.Utils.XmlDocument.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Utils.XmlItem.html b/ClassReference/api/FastReport.Utils.XmlItem.html index c7ba92d..dfc0e7b 100644 --- a/ClassReference/api/FastReport.Utils.XmlItem.html +++ b/ClassReference/api/FastReport.Utils.XmlItem.html @@ -10,7 +10,7 @@ - + @@ -545,7 +545,8 @@
Returns
Remarks
-

This method adds the node with specified name to the child nodes if it cannot find the node.

+

This method adds the node with specified name to the child nodes if it cannot find the node. +Do not dispose items, which has been created by this method

diff --git a/ClassReference/api/FastReport.Utils.XmlProperty.html b/ClassReference/api/FastReport.Utils.XmlProperty.html index 90b9142..054d0df 100644 --- a/ClassReference/api/FastReport.Utils.XmlProperty.html +++ b/ClassReference/api/FastReport.Utils.XmlProperty.html @@ -10,7 +10,7 @@ - + @@ -73,7 +73,7 @@

Struct XmlProperty

-

Represents a xml property.

+

Represents a xml property.///

diff --git a/ClassReference/api/FastReport.Utils.ZipArchive.html b/ClassReference/api/FastReport.Utils.ZipArchive.html index 7557f9f..45abbd8 100644 --- a/ClassReference/api/FastReport.Utils.ZipArchive.html +++ b/ClassReference/api/FastReport.Utils.ZipArchive.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Utils.html b/ClassReference/api/FastReport.Utils.html index 23baaf3..1d652c1 100644 --- a/ClassReference/api/FastReport.Utils.html +++ b/ClassReference/api/FastReport.Utils.html @@ -10,7 +10,7 @@ - + @@ -77,6 +77,33 @@

Namespa

Classes

+

AdvancedTextRenderer

+

Advanced text renderer is used to perform the following tasks:

+
    +
  • draw justified text, text with custom line height, text containing html tags;
  • +
  • calculate text height, get part of text that does not fit in the display rectangle;
  • +
  • get paragraphs, lines, words and char sequence to perform accurate export to such +formats as PDF, TXT, RTF
  • +
+
+

AdvancedTextRenderer.Line

+

Line represents single text line. It consists of one or several Words. +Simple line (that does not contain tabs, html tags, and is not justified) has +single AdvancedTextRenderer.Word which contains all the text.

+
+

AdvancedTextRenderer.Paragraph

+

Paragraph represents single paragraph. It consists of one or several Lines.

+
+

AdvancedTextRenderer.Run

+

Represents sequence of characters that have the same Style.

+
+

AdvancedTextRenderer.StyleDescriptor

+

Represents a style used in HtmlTags mode.

+
+

AdvancedTextRenderer.Word

+

Word represents single word. It may consist of one or several Runs, in case +when HtmlTags are enabled in the main AdvancedTextRenderer class.

+

AncestorException

The exception that is thrown when the user tried to rename an object that is introduced in the ancestor report.

@@ -90,6 +117,9 @@

ClassExceptionCloudStorageException

throws this exception if an error occurs in the SaveReport method. See inner exception for detailed information.

+
+

CompileHelper

+

Class helper for compile source code with path of assemblies

CompilerException

The exception that is thrown if there is an error in the report's script code.

@@ -114,6 +144,8 @@

DataTableExc

DecryptException

The exception that is thrown when loading an encrypted report with wrong password.

+

DrawUtils

+

DuplicateNameException

The exception that is thrown when the user tried to set object's name that is already exists.

@@ -142,6 +174,9 @@

FRReader

FRWriter

The writer used to serialize object's properties to a report file.

+
+

GroupHeaderHasNoGroupCondition

+

The exception that is thrown when the Group Header has no group condition.

InlineImageCache

Cache for rendering img tags in textobject. @@ -169,7 +204,7 @@

MyRes

Used to access to resource IDs inside the specified branch.

NotValidIdentifierException

-

The exception that is thrown if an error occurs in the MatrixObject.ManualBuild event.

+

The exception that is thrown if a report object's Name property is set to wrong value.

ObjectInfo

Holds the information about the registered object.

@@ -195,6 +230,9 @@

Table

Units

Defines the constants used to convert between report units and screen pixels.

+
+

UnknownNameException

+

The exception that is thrown if an unknown value is supplied to some methods dealing with totals, variables etc.

XmlDocument

Represents a xml document that contains the root xml node.

@@ -207,10 +245,21 @@

ZipArchive

Structs

XmlProperty

-

Represents a xml property.

+

Represents a xml property.///

+
+

Interfaces +

+

IGraphicsRenderer

+

The interface for unifying methods for drawing objects into different graphics

+
+

IGraphicsRendererState

+

the interface for saving and restoring state

Enums

+

AdvancedTextRenderer.BaseLine

+

Represents character placement.

+

PageUnits

The report page units.

diff --git a/ClassReference/api/FastReport.Variant.html b/ClassReference/api/FastReport.Variant.html index 9b5cab7..e1a2a39 100644 --- a/ClassReference/api/FastReport.Variant.html +++ b/ClassReference/api/FastReport.Variant.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.VertAlign.html b/ClassReference/api/FastReport.VertAlign.html index 9d7b6c0..e021ef4 100644 --- a/ClassReference/api/FastReport.VertAlign.html +++ b/ClassReference/api/FastReport.VertAlign.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.Watermark.html b/ClassReference/api/FastReport.Watermark.html index 764af27..ae3eeb6 100644 --- a/ClassReference/api/FastReport.Watermark.html +++ b/ClassReference/api/FastReport.Watermark.html @@ -10,7 +10,7 @@ - + @@ -536,6 +536,49 @@
Parameters
+ +

DrawText(FRPaintEventArgs, RectangleF, Report, Boolean)

+

Draws watermark text.

+
+
+
Declaration
+
+
public void DrawText(FRPaintEventArgs e, RectangleF displayRect, Report report, bool isPrinting)
+
+
Parameters
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescription
FRPaintEventArgse
RectangleFdisplayRect
Reportreport
System.BooleanisPrinting
+ +

Serialize(FRWriter, String, Watermark)

Serializes the watermark.

diff --git a/ClassReference/api/FastReport.WatermarkImageSize.html b/ClassReference/api/FastReport.WatermarkImageSize.html index 81b8e9b..6c42f61 100644 --- a/ClassReference/api/FastReport.WatermarkImageSize.html +++ b/ClassReference/api/FastReport.WatermarkImageSize.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.WatermarkTextRotation.html b/ClassReference/api/FastReport.WatermarkTextRotation.html index d9092c2..59e9af7 100644 --- a/ClassReference/api/FastReport.WatermarkTextRotation.html +++ b/ClassReference/api/FastReport.WatermarkTextRotation.html @@ -10,7 +10,7 @@ - + diff --git a/ClassReference/api/FastReport.ZipCodeObject.html b/ClassReference/api/FastReport.ZipCodeObject.html index 5281562..c7daa20 100644 --- a/ClassReference/api/FastReport.ZipCodeObject.html +++ b/ClassReference/api/FastReport.ZipCodeObject.html @@ -10,7 +10,7 @@ - + @@ -102,9 +102,6 @@
Inherited Members
- @@ -213,6 +210,9 @@
Inherited Members
+ @@ -297,6 +297,9 @@
Inherited Members
+ @@ -387,9 +390,6 @@
Inherited Members
- @@ -695,7 +695,8 @@

Methods

Assign(Base)

-
+

Copies the contents of another, similar object.

+
Declaration
@@ -714,12 +715,28 @@
Parameters
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(Base) method. +

+
+
See Also
+ @@ -753,7 +770,8 @@
Overrides

GetData()

-
+

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

+
Declaration
@@ -761,11 +779,17 @@
Declaration
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. +

GetExpressions()

-
+

Gets all expressions contained in the object.

+
Declaration
@@ -782,17 +806,29 @@
Returns
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
@@ -811,12 +847,24 @@
Parameters
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(Base) methods; +
  • saving the object to the designer's clipboard;
  • saving the object to the preview (when run a +report).
+

Implements

IFRSerializable diff --git a/ClassReference/api/FastReport.html b/ClassReference/api/FastReport.html index 958c3bb..f6a8536 100644 --- a/ClassReference/api/FastReport.html +++ b/ClassReference/api/FastReport.html @@ -10,7 +10,7 @@ - + @@ -186,6 +186,9 @@

HtmlObject

Hyperlink

This class contains a hyperlink settings.

+
+

JsonBase

+

Allows working with JsonObject

LinearGradientFill

Class represents the linear gradient fill.

@@ -223,6 +226,9 @@

PathGradientFill

PictureObject

Represents a Picture object that can display pictures.

+
+

PictureObjectBase

+

the base class for all picture objects

PolygonObject

Represents a polygon object.

@@ -230,6 +236,11 @@

PolygonObject

PolyLineObject

Represents a poly line object.

+

PolyLineObject.PolyPoint

+

Represent a point for polygon object

+
+

PolyLineObject.PolyPointCollection

+

ProgressEventArgs

Provides data for the Progress event.

@@ -292,6 +303,9 @@

TextObjectBase

TextOutline

Represents text outline.

+
+

TextureFill

+

Class represents the Texture fill.

Watermark

Represents the report page watermark.

@@ -344,6 +358,9 @@

HorzAlign

HyperlinkKind

Specifies the hyperlink type.

+
+

ImageAlign

+

Specifies the alignment of a image in the border.

Language

Specifies the language of the report's script.

@@ -360,6 +377,8 @@

PageRange

PathGradientStyle

The style of the path gradient.

+

PolyLineObject.PolygonSelectionMode

+

PrintOn

Specifies where to print an object.

diff --git a/ClassReference/api/toc.html b/ClassReference/api/toc.html index eed2801..c5ef340 100644 --- a/ClassReference/api/toc.html +++ b/ClassReference/api/toc.html @@ -178,9 +178,15 @@
  • IFRSerializable
  • +
  • + ImageAlign +
  • IParent
  • +
  • + JsonBase +
  • Language
  • @@ -232,12 +238,24 @@
  • PictureObject
  • +
  • + PictureObjectBase +
  • PolygonObject
  • PolyLineObject
  • +
  • + PolyLineObject.PolygonSelectionMode +
  • +
  • + PolyLineObject.PolyPoint +
  • +
  • + PolyLineObject.PolyPointCollection +
  • PrintOn
  • @@ -337,6 +355,9 @@
  • TextRenderType
  • +
  • + TextureFill +
  • UncheckedSymbol
  • @@ -554,6 +575,9 @@
  • ColumnCollection
  • +
  • + ColumnComparer +
  • ColumnFormat
  • @@ -593,6 +617,9 @@
  • DataSourceCollection
  • +
  • + DataSourceComparer +
  • DateVariable
  • @@ -688,6 +715,22 @@ +
  • + + FastReport.Data.JsonConnection + + +
  • FastReport.Engine @@ -1008,6 +1051,27 @@ FastReport.Utils