FdcGridExportButton class
Built-in toolbar item that exports dataset rows through the FDC export pipeline.
- Inheritance
-
- Object
- FdcGridItem
- FdcGridExportButton
Constructors
-
FdcGridExportButton({String? id, bool visible = false, FdcGridItemPlacement placement = FdcGridItemPlacement.start, List<
FdcExportFormat> ? formats, FdcExportScope scope = FdcExportScope.currentView, FdcExportValueMode valueMode = FdcExportValueMode.raw, FdcGridExportColumnMode columnMode = FdcGridExportColumnMode.visibleColumns, bool includeHeaders = true, bool includeNonPersistentFields = false, Map<FdcExportFormat, FdcExportWriterOptions> writerOptions = const <FdcExportFormat, FdcExportWriterOptions>{}, String? label, String tooltip = defaultTooltip, FdcGridExportCompleted? onExport}) -
Creates a FdcGridExportButton.
const
Properties
- columnMode → FdcGridExportColumnMode
-
Column source used by the built-in grid command.
final
-
effectiveFormats
→ List<
FdcExportFormat> -
Effective formats shown by the built-in export menu.
no setter
-
formats
→ List<
FdcExportFormat> ? -
Formats shown in the built-in export menu.
final
- hashCode → int
-
The hash code for this object.
no setteroverride
- id → String?
-
Optional stable identifier for locating or customizing this item.
finalinherited
- includeHeaders → bool
-
Includes column labels as the first row when the selected writer format supports headers.
final
- includeNonPersistentFields → bool
-
Includes calculated/non-persistent dataset fields in dataset-level export.
final
- label → String?
-
Optional toolbar button label. When omitted, an icon-only button is shown.
final
- onExport → FdcGridExportCompleted?
-
Called with the generated text export result.
final
- placement → FdcGridItemPlacement
-
Placement zone used by the host when arranging this item.
finalinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- scope → FdcExportScope
-
Dataset row scope exported by the built-in grid command.
final
- tooltip → String
-
Toolbar/export menu tooltip.
final
- valueMode → FdcExportValueMode
-
Value conversion used by the built-in grid command.
final
- visible → bool
-
Whether this item participates in the host toolbar or status bar.
finalinherited
-
writerOptions
→ Map<
FdcExportFormat, FdcExportWriterOptions> -
Per-format writer options applied only by this export button.
final
Methods
-
buildItem(
BuildContext context) → Widget -
Builds a host-independent item.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toExportOptions(
{List< FdcExportColumn> ? columns}) → FdcExportOptions -
Builds dataset export options from this toolbar configuration and optional resolved
columns. -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
override
Constants
- defaultTooltip → const String
- Default toolbar/export menu tooltip.