Class MatrixCollapseButton

Represents the matrix button used to toggle expand/collapse state of matrix headers.

Inheritance
System.Object
Base
ComponentBase
ReportComponentBase
MatrixButton
MatrixCollapseButton
Implements
Inherited Members
Namespace: FastReport.AdvMatrix
Assembly: FastReport.dll
Syntax
public class MatrixCollapseButton : MatrixButton, IDisposable, IFRSerializable

Constructors

MatrixCollapseButton()

Initializes a new instance of the MatrixCollapseButton class.

Declaration
public MatrixCollapseButton()

Properties

Collapsed

Determines whether this button has a collapsed state. For internal use only.

Declaration
[Browsable(false)]
public bool Collapsed { get; set; }
Property Value
Type Description
System.Boolean

Exclusive

Determines if only one button in the group can be expanded.

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

ShowCollapseExpandMenu

Determines whether to show collapse/expand menu on right click.

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

Symbol

Determines the symbol used to display the button's state.

Declaration
public CollapseSymbol Symbol { get; set; }
Property Value
Type Description
CollapseSymbol

Methods

Assign(Base)

Copies the contents of another, similar object.

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

Source object to copy the contents from.
Overrides
Remarks

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

destination.Assign(source);

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

See Also

Draw(FRPaintEventArgs)

Draws the object.

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

Paint event args.
Overrides
Remarks

This method is widely used in the FastReport. It is called each time when the object needs to draw or print itself.

In order to draw the object correctly, you should multiply the object's bounds by the scale parameter.

cache parameter is used to optimize the drawing speed. It holds all items such as pens, fonts, brushes, string formats that was used before. If the item with requested parameters exists in the cache, it will be returned (instead of create new item and then dispose it).

MatrixCollapseButtonClick()

For internal use only,return action click for Advanced Matrix collapse button

Declaration
public void MatrixCollapseButtonClick()

Serialize(FRWriter)

Serializes the object.

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

Writer object.
Overrides
Remarks

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

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

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

Implements