WinForms › Combo Box › MultiColumnViewUIElementsTextProvider

MultiColumnViewUIElementsTextProvider

class.NET 6 / 8 / 10.NET Framework 4.8Binarymission.WinForms.Controls.ListControls

The captions, menu commands and messages of the BinaryTextComboBox multi-column drop-down, gathered in one place so they can be translated or reworded.

public sealed class MultiColumnViewUIElementsTextProvider

Remarks

Every combo box has one, in BinaryTextComboBox.MultiColumnViewUIElementsTextProvider. Change its properties in the Properties window, where it expands, or in code; the drop-down reads them each time it opens. Each property starts with the English text shown in its description.

The two messages the drop-down shows while it works and when a filter finds nothing are properties of the combo box itself: BinaryTextComboBox.MultiColumnViewBusyProcessingText and BinaryTextComboBox.MultiColumnViewNoDataFoundText.

Examples

var text = customerPicker.MultiColumnViewUIElementsTextProvider;
text.WindowItemShowFilterAndGroupingOptions = "Filter- und Gruppierungsoptionen anzeigen";
text.WindowItemHideFilterAndGroupingOptions = "Filter- und Gruppierungsoptionen ausblenden";
text.WindowItemUseFilterToRetrieveData = "Daten filtern";
text.WindowComboBoxItemBuiltInFilter = "Standardfilter";
text.WindowComboBoxItemCustomExpression = "Eigener Ausdruck";
text.ContextMenuItemExportDataToCSV = "Als CSV exportieren";

Members at a glance

Properties
`ContextMenuItemEnableDataGroupingText`	Gets or sets the shortcut-menu command that groups the rows by the column the user clicked last, and ungroups them.
`ContextMenuItemEnableFilterOptionsText`	Gets or sets the shortcut-menu command that switches filtering on and off.
`ContextMenuItemExportDataToCSV`	Gets or sets the shortcut-menu command that exports the rows shown to the file named by `BinaryTextComboBox.CSVFileSaveAs`.
`ContextMenuItemShowCommandBarText`	Gets or sets the shortcut-menu command that shows and hides the drop-down's status strip.
`WindowComboBoxItemBuiltInFilter`	Gets or sets the name of the built-in filter, as the filter type list and the status line show it.
`WindowComboBoxItemCustomExpression`	Gets or sets the name of the custom-expression filter, as the filter type list and the status line show it.
`WindowComboBoxItemFilterOnThisColumn`	Gets or sets the label of the list in the options pane that chooses the column the built-in filter searches.
`WindowItemEnableGrouping`	Gets or sets a caption for the options pane's grouping check box. The drop-down does not use it.
`WindowItemFilterDataWhileTheUserTypesExpression`	Gets or sets the caption of the check box in the options pane that makes the built-in filter apply as the user types, rather than when they press OK.
`WindowItemFilterExpression`	Gets or sets the label of the box in the options pane where the user types the filter.
`WindowItemFilterExpressionType`	Gets or sets the label of the list in the options pane that chooses between the built-in filter and a custom expression.
`WindowItemFilterExpressionTypeComboBoxTooltip`	Gets or sets the tooltip of the filter type list, which explains the two kinds of filter.
`WindowItemFilteringStatusPart`	Gets or sets the opening words of the options pane's status line, which goes on to name the filter type in use.
`WindowItemGroupOnThisColumn`	Gets or sets the caption of the grouping check box and the label of the list that chooses the column to group by, in the options pane.
`WindowItemHideFilterAndGroupingOptions`	Gets or sets the caption of the status-strip button that hides the filter and grouping pane.
`WindowItemShowFilterAndGroupingOptions`	Gets or sets the caption of the status-strip button that shows the hidden filter and grouping pane.
`WindowItemUseFilterToRetrieveData`	Gets or sets the caption of the check box in the options pane that switches filtering on.
`WindowStatusBarCustomExpressionErrorMessage`	Gets or sets the message the status strip shows when the filter expression the user wrote cannot be evaluated.
`WindowTaskStatusMessageForCSVExportSuccessful`	Gets or sets the message the status strip shows after the rows have been exported to a CSV file.

Properties

ContextMenuItemEnableDataGroupingText

public string ContextMenuItemEnableDataGroupingText

Gets or sets the shortcut-menu command that groups the rows by the column the user clicked last, and ungroups them.

Value: The text. The default is "Enable data grouping".

ContextMenuItemEnableFilterOptionsText

public string ContextMenuItemEnableFilterOptionsText

Gets or sets the shortcut-menu command that switches filtering on and off.

Value: The text. The default is "Enable filter options".

Remarks

The command is on the menu only while the filter and grouping pane is in use.

ContextMenuItemExportDataToCSV

public string ContextMenuItemExportDataToCSV

Gets or sets the shortcut-menu command that exports the rows shown to the file named by BinaryTextComboBox.CSVFileSaveAs.

Value: The text. The default is "Export data to CSV".

ContextMenuItemShowCommandBarText

public string ContextMenuItemShowCommandBarText

Gets or sets the shortcut-menu command that shows and hides the drop-down's status strip.

Value: The text. The default is "Show command bar".

Remarks

The command is on the menu only while the filter and grouping pane is in use.

WindowComboBoxItemBuiltInFilter

public string WindowComboBoxItemBuiltInFilter

Gets or sets the name of the built-in filter, as the filter type list and the status line show it.

Value: The text. The default is "Built-in filter".

WindowComboBoxItemCustomExpression

public string WindowComboBoxItemCustomExpression

Gets or sets the name of the custom-expression filter, as the filter type list and the status line show it.

Value: The text. The default is "Custom expression".

WindowComboBoxItemFilterOnThisColumn

public string WindowComboBoxItemFilterOnThisColumn

Gets or sets the label of the list in the options pane that chooses the column the built-in filter searches.

Value: The text. The default is "Filter on this column:".

WindowItemEnableGrouping

public string WindowItemEnableGrouping

Gets or sets a caption for the options pane's grouping check box. The drop-down does not use it.

Value: The text. The default is Enable "grouping".

Remarks

The grouping check box shows WindowItemGroupOnThisColumn instead.

WindowItemFilterDataWhileTheUserTypesExpression

public string WindowItemFilterDataWhileTheUserTypesExpression

Gets or sets the caption of the check box in the options pane that makes the built-in filter apply as the user types, rather than when they press OK.

Value: The text. The default is "Filter data while the user types expression?".

WindowItemFilterExpression

public string WindowItemFilterExpression

Gets or sets the label of the box in the options pane where the user types the filter.

Value: The text. The default is "Filter expression:".

WindowItemFilterExpressionType

public string WindowItemFilterExpressionType

Gets or sets the label of the list in the options pane that chooses between the built-in filter and a custom expression.

Value: The text. The default is "Filter expression type:".

WindowItemFilterExpressionTypeComboBoxTooltip

public string WindowItemFilterExpressionTypeComboBoxTooltip

Gets or sets the tooltip of the filter type list, which explains the two kinds of filter.

Value: The text. The default is four lines of English explaining the built-in filter and the custom expression.

WindowItemFilteringStatusPart

public string WindowItemFilteringStatusPart

Gets or sets the opening words of the options pane's status line, which goes on to name the filter type in use.

Value: The text. The default is "Filter status: Filtering is currently using".

Remarks

The line reads, for example, Filter status: Filtering is currently using "Built-in filter".

WindowItemGroupOnThisColumn

public string WindowItemGroupOnThisColumn

Gets or sets the caption of the grouping check box and the label of the list that chooses the column to group by, in the options pane.

Value: The text. The default is "Group on this column:".

WindowItemHideFilterAndGroupingOptions

public string WindowItemHideFilterAndGroupingOptions

Gets or sets the caption of the status-strip button that hides the filter and grouping pane.

Value: The text. The default is "Hide filter and grouping options".

WindowItemShowFilterAndGroupingOptions

public string WindowItemShowFilterAndGroupingOptions

Gets or sets the caption of the status-strip button that shows the hidden filter and grouping pane.

Value: The text. The default is "Show filter and grouping options".

WindowItemUseFilterToRetrieveData

public string WindowItemUseFilterToRetrieveData

Gets or sets the caption of the check box in the options pane that switches filtering on.

Value: The text. The default is "Use filter to retrieve data".

WindowStatusBarCustomExpressionErrorMessage

public string WindowStatusBarCustomExpressionErrorMessage

Gets or sets the message the status strip shows when the filter expression the user wrote cannot be evaluated.

Value: The text. The default is "Invalid custom expression. Please correct.".

Remarks

The expression is cleared when it is shown.

WindowTaskStatusMessageForCSVExportSuccessful

public string WindowTaskStatusMessageForCSVExportSuccessful

Gets or sets the message the status strip shows after the rows have been exported to a CSV file.

Value: The text. The default is "Command result: CSV export successful.", preceded by spaces that set it apart from the strip's button.