StiComponentDesigner Class
Namespace: Stimulsoft.Report.Components.Design
Class describes base designer of components.
Inheritance
Implements: IStiComponentDesigner
Constructors
| Constructor | Description |
|---|---|
| StiComponentDesigner(IStiDesignerBase designer) | Creates a new designer of the component. |
StiComponentDesigner(designer: IStiDesignerBase)
Creates a new designer of the component.
Parameters
- designer (IStiDesignerBase) — Report designer.
Properties
| Property | Type | Description |
|---|---|---|
| Designer | IStiDesignerBase | Report designer. |
| FirstRun | bool |
Methods
| Method | Returns | Description |
|---|---|---|
| CreateComponent | StiComponent | Creates a component of the specified type. |
| Design | DialogResult | Calls the designer of the component. |
| GetActionFromPoint (+1 overloads) | StiAction | |
GetComponentDesigner static (+1 overloads) |
StiComponentDesigner | Returns a designer of the component. |
| OnDoubleClick | void | Occurs when user DoubleClick on a the component in the designer. |
| PointInRect | StiAction | Returns the action fits to the position of a point in the specified rectangle. |
Method Details
CreateComponent
CreateComponent(componentType: Type, region: RectangleD): StiComponent
Creates a component of the specified type.
Parameters
- componentType (Type) — Type of conmponent being ceated.
- region (RectangleD) — The rectangle describes the component size.
Returns StiComponent — Created component.
Design
Design(component: StiComponent): DialogResult
Calls the designer of the component.
Parameters
- component (StiComponent) — Component for edition.
Returns DialogResult — Result of showing the component designer.
GetActionFromPoint
GetActionFromPoint(x: double, y: double, component: StiComponent): StiAction
Parameters
- x (double)
- y (double)
- component (StiComponent)
Returns StiAction
GetActionFromPoint(x: double, y: double, component: StiComponent, forGetDesigner: bool): StiAction
Returns StiAction for specified component from point.
Parameters
- x (double) — x coordinate.
- y (double) — y coordinate.
- component (StiComponent) — Component for checking.
- forGetDesigner (bool)
Returns StiAction — Action for this point.
GetComponentDesigner static
GetComponentDesigner(designer: IStiDesignerBase, componentType: Type): StiComponentDesigner
Returns a designer of the component.
Parameters
- designer (IStiDesignerBase) — Report designer.
- componentType (Type) — Component type.
Returns StiComponentDesigner — Component designer.
GetComponentDesigner(designer: IStiDesignerBase, componentType: Type, guiMode: StiGuiMode): StiComponentDesigner
Returns a designer of the component.
Parameters
- designer (IStiDesignerBase) — Report designer.
- componentType (Type) — Component type.
- guiMode (StiGuiMode)
Returns StiComponentDesigner — Component designer.
OnDoubleClick
OnDoubleClick(sender: StiComponent): void
Occurs when user DoubleClick on a the component in the designer.
Parameters
- sender (StiComponent) — Component on what DoubleClick occured.
PointInRect
PointInRect(designer: IStiDesignerBase, comp: StiComponent, x: int, y: int): StiAction
Returns the action fits to the position of a point in the specified rectangle.
Parameters
- designer (IStiDesignerBase)
- comp (StiComponent)
- x (int) — X point.
- y (int) — Y point.
Returns StiAction — Action.