### GetApplyInitialSorting Method Source: https://github.com/dotnet/datagridextensions/blob/master/docs/html/adfe8613-2d62-13b0-dd29-14bc87e099c1.htm Gets the flag to enable the 'apply initial sorting' feature. This is a public static method. ```APIDOC ## GetApplyInitialSorting ### Description Gets the flag to enable the 'apply initial sorting' feature. ### Method Public Static Method ### Parameters None explicitly documented. ### Response Details not provided in the source. ``` -------------------------------- ### GetApplyInitialSorting Source: https://github.com/dotnet/datagridextensions/blob/master/docs/html/90f8ff5d-5eac-1e58-6898-43a71ad12c82.htm Gets the flag to enable the 'apply initial sorting' feature for a data grid. This is a static method. ```APIDOC ## GetApplyInitialSorting ### Description Gets the flag that indicates whether the 'apply initial sorting' feature is enabled for a data grid. ### Method GET (assumed, as it's a getter method) ### Endpoint Not applicable (SDK method) ### Parameters None explicitly documented for this getter. ### Response - Returns a boolean flag indicating if initial sorting is applied. ``` -------------------------------- ### SimpleContentFilterFactory Properties Source: https://github.com/dotnet/datagridextensions/blob/master/docs/html/247836b4-6684-cfc8-d23c-b79799dd6239.htm Gets or sets the string comparison. ```APIDOC ## StringComparison ### Description Gets or sets the string comparison. ### Method Property ### Parameters None ### Response - **StringComparison** (StringComparison) - The string comparison setting. ``` -------------------------------- ### ResourceLocator Property Source: https://github.com/dotnet/datagridextensions/blob/master/docs/html/c17227b8-b8cc-de61-8bb3-517276989a40.htm Gets or sets the resource locator. ```APIDOC ## ResourceLocator ### Description Gets or sets the resource locator. ### Method Property Accessor ### Parameters None ### Response - **object** (System.Object) - The resource locator. ``` -------------------------------- ### DataGrid Extensions Sample Window Setup Source: https://github.com/dotnet/datagridextensions/wiki/Filtering This XML defines the main window for the DataGrid Extensions sample application, including necessary namespaces and resource definitions for custom filters and templates. ```xml This tab shows the very basic usage. Just set the IsAutoFilterEnabled property to True, and get the simple but efficient default filter. This tab shows how to customize the filters when using auto generated columns. See the DataGrid_AutoGeneratingColumn event handler for details. - Overrides the content filter factory to use the regex matching instead of the default simple "string contains" matching. - Uses the sample IntergerFilter for the Index column. This tab shows how to customize the filters in XAML when using explicit generated columns. Read the comments in the XAML for details. Overrides the icon template to show an orange filter symbol. ### Syntax ```csharp public ICollection Columns { get; } ``` ```vb Public ReadOnly Property Columns As ICollection(Of DataGridColumn) Get End Property ``` ``` -------------------------------- ### GetResourceLocator Method Source: https://github.com/dotnet/datagridextensions/blob/master/docs/html/5cc36221-6dfc-32c4-a565-7a31acab8b2e.htm Gets the resource locator for a given DataGrid object. This is an extension method that can be called directly on a DataGrid instance. ```APIDOC ## GetResourceLocator Method ### Description Gets the resource locator. ### Method GET (Extension Method) ### Endpoint N/A (Extension Method) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example ```csharp // Instance method syntax IResourceLocator locator = myDataGrid.GetResourceLocator(); // Static method syntax IResourceLocator locator = DataGridFilter.GetResourceLocator(myDataGrid); ``` ### Response #### Success Response (200) - **Return Value** (IResourceLocator) - The locator #### Response Example ```json // The actual return value depends on the implementation of IResourceLocator // Example: Could be an object implementing IResourceLocator { "locatorType": "SpecificLocatorImplementation" } ``` ``` -------------------------------- ### ApplyInitialSortingBehavior Constructor Source: https://github.com/dotnet/datagridextensions/blob/master/docs/html/998367e0-ca85-f048-0327-b3c5dc41aec9.htm Initializes a new instance of the ApplyInitialSortingBehavior class. ```APIDOC ## ApplyInitialSortingBehavior Constructor ### Description Initializes a new instance of the ApplyInitialSortingBehavior class. ### Method Constructor ### Parameters None ### Request Example None ### Response None ``` -------------------------------- ### VB Syntax for SelectAllContent Property Source: https://github.com/dotnet/datagridextensions/blob/master/docs/html/b465e241-6ee6-1747-01aa-a2fb6ecc6edf.htm Provides the Visual Basic syntax for getting and setting the SelectAllContent property. This property is of type Object and allows for custom content for the select all checkbox. ```vb Public Property SelectAllContent As Object Get Set ``` -------------------------------- ### GetFilter Source: https://github.com/dotnet/datagridextensions/blob/master/docs/html/cc6f7672-4a80-3efd-d9cb-242e0b7d5cb3.htm Gets the filter expression of the column. This is a public static method. ```APIDOC ## GetFilter ### Description Gets the filter expression of the column. ### Method Public static method ### Endpoint N/A (Method call) ### Parameters N/A ### Request Example N/A ### Response - **filter expression** (type unknown) - Description of the filter expression ``` -------------------------------- ### Attaching Behaviors to DataGrid Source: https://github.com/dotnet/datagridextensions/wiki/Behaviors Demonstrates how to attach multiple behaviors to a DataGrid using XAML. Ensure the necessary namespaces are imported. ```xml ``` -------------------------------- ### ExtendedStarSizeBehavior.ColumnHeaderGripperToolTipStyle Property Source: https://github.com/dotnet/datagridextensions/blob/master/docs/html/7e3c3ae0-f024-64e5-8eb4-ca1215a59398.htm Gets or sets the style of the tool tip for the grippers in the column headers. This property belongs to the ExtendedStarSizeBehavior class within the DataGridExtensions.Behaviors namespace. ```APIDOC ## ExtendedStarSizeBehavior.ColumnHeaderGripperToolTipStyle Property ### Description Gets or sets the style of the tool tip for the grippers in the column headers. ### Namespace DataGridExtensions.Behaviors ### Assembly DataGridExtensions (in DataGridExtensions.dll) ### Syntax #### C# ```csharp public Style ColumnHeaderGripperToolTipStyle { get; set; } ``` #### VB ```vb Public Property ColumnHeaderGripperToolTipStyle As Style Get Set ``` ### Property Value Type: Style ### See Also - [ExtendedStarSizeBehavior Class](c17227b8-b8cc-de61-8bb3-517276989a40.htm) - [DataGridExtensions.Behaviors Namespace](1bd337c0-1e3a-e5af-76c4-b33120ad52ec.htm) ``` -------------------------------- ### GetActiveFilter Source: https://github.com/dotnet/datagridextensions/blob/master/docs/html/cc6f7672-4a80-3efd-d9cb-242e0b7d5cb3.htm Gets the filter expression of the column. This is a public static method. ```APIDOC ## GetActiveFilter ### Description Gets the filter expression of the column. ### Method Public static method ### Endpoint N/A (Method call) ### Parameters N/A ### Request Example N/A ### Response - **filter expression** (type unknown) - Description of the filter expression ``` -------------------------------- ### GetIsAutoFilterEnabled Method Source: https://github.com/dotnet/datagridextensions/blob/master/docs/html/bc24b420-28f0-9a5c-ccf9-601329e57a94.htm Gets if the default filters are automatically attached to each column. ```APIDOC ## GetIsAutoFilterEnabled Method ### Description Gets if the default filters are automatically attached to each column. ### Method static bool GetIsAutoFilterEnabled(DataGrid dataGrid) ### Parameters #### Path Parameters * **dataGrid** (DataGrid) - Required - The data grid. ### Response #### Success Response (bool) * **true** if auto-filtering is enabled. ### Usage Note In Visual Basic and C#, you can call this method as an instance method on any object of type DataGrid. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide). ``` -------------------------------- ### ApplyInitialSorting Source: https://github.com/dotnet/datagridextensions/blob/master/docs/html/90f8ff5d-5eac-1e58-6898-43a71ad12c82.htm This property is a shortcut for the ApplyInitialSortingBehavior. This is a public attached property. ```APIDOC ## ApplyInitialSorting ### Description This property serves as a shortcut for the ApplyInitialSortingBehavior. ### Type Attached Property ### Usage Can be set on UI elements to enable the initial sorting feature. ``` -------------------------------- ### DisableTargetWhileEditingBehavior.Target Property Source: https://github.com/dotnet/datagridextensions/blob/master/docs/html/a3e0b400-dba4-20c6-a0d6-cb4d96bfcc4b.htm Gets or sets the target element that will be disabled during editing. ```APIDOC ## DisableTargetWhileEditingBehavior.Target Property ### Description Gets or sets the target element that will be disabled during editing. ### Syntax #### C# ```csharp public UIElement Target { get; set; } ``` #### VB ```vb Public Property Target As UIElement Get Set ``` ### Property Value Type: UIElement The target element that will be disabled during editing. ``` -------------------------------- ### GetApplyInitialSorting Method Signature (C#) Source: https://github.com/dotnet/datagridextensions/blob/master/docs/html/3ed3502d-1615-f795-49ca-b1055d4a92cb.htm This is the C# signature for the GetApplyInitialSorting method. It is an extension method for DataGrid. ```csharp public static bool GetApplyInitialSorting( this DataGrid dataGrid ) ``` -------------------------------- ### DataGridFilterColumn Methods Source: https://github.com/dotnet/datagridextensions/blob/master/docs/html/57bf7338-648a-d577-7401-253ef947a595.htm Provides methods to interact with data grid column filters, including getting and setting filter expressions, controlling filter visibility, and managing filter templates. ```APIDOC ## DataGridFilterColumn Methods ### Description Methods for managing data grid column filters. ### Methods - **GetActiveFilter**: Gets the filter expression of the column. - **GetFilter**: Gets the filter expression of the column. - **GetFilterHost**: Gets the filter host for the data grid of this column. - **GetIsFilterVisible**: Controls the visibility of the filter for this column. - **GetTemplate**: Gets the control template for the filter of this column. If the template is null or unset, a default template will be used. - **SetActiveFilter**: Sets the filter expression of the column. - **SetFilter**: Sets the filter expression of the column. - **SetFilterHost**: Sets the filter host for the data grid of this column. - **SetIsFilterVisible**: Controls the visibility of the filter for this column. - **SetTemplate**: Sets the control template for the filter of this column. If the template is null or unset, a default template will be used. ``` -------------------------------- ### ClearTextBoxOnButtonClickBehavior Constructor Source: https://github.com/dotnet/datagridextensions/blob/master/docs/html/b1339a43-a8c8-70b0-7876-ec4c209f3f3d.htm Initializes a new instance of the ClearTextBoxOnButtonClickBehavior class. ```APIDOC ## ClearTextBoxOnButtonClickBehavior Constructor ### Description Initializes a new instance of the [ClearTextBoxOnButtonClickBehavior](ed07a7cb-985f-34c2-53e2-67c23be02c06.htm) class. ### Syntax ```csharp public ClearTextBoxOnButtonClickBehavior() ``` ```vb Public Sub New ``` ### See Also - [ClearTextBoxOnButtonClickBehavior Class](ed07a7cb-985f-34c2-53e2-67c23be02c06.htm) - [DataGridExtensions.Behaviors Namespace](1bd337c0-1e3a-e5af-76c4-b33120ad52ec.htm) ``` -------------------------------- ### Target Property Source: https://github.com/dotnet/datagridextensions/blob/master/docs/html/88cf7ccc-9cc1-b6a9-78ac-2542039e5a8b.htm Gets or sets the target element that will be disabled during editing. ```APIDOC ## Target Property ### Description Gets or sets the target element that will be disabled during editing. ### Syntax ```csharp public DependencyObject Target { get; set; } ``` ```vb Public Property Target As DependencyObject ``` ``` -------------------------------- ### SimpleContentFilterFactory Fields Source: https://github.com/dotnet/datagridextensions/blob/master/docs/html/247836b4-6684-cfc8-d23c-b79799dd6239.htm The default instance. ```APIDOC ## Default ### Description The default instance. ### Method Field (Static) ### Parameters None ### Response - **SimpleContentFilterFactory** - The default instance of the class. ``` -------------------------------- ### GetContentFilterFactory Method Source: https://github.com/dotnet/datagridextensions/blob/master/docs/html/e013db0f-3874-6ad6-3501-ce9e5d530edd.htm Gets the content filter factory for the data grid filter. ```APIDOC ## GetContentFilterFactory ### Description Gets the content filter factory for the data grid filter. ### Method Public Static Method ### Endpoint N/A (Method Call) ### Parameters None explicitly documented. ### Request Example N/A ### Response N/A ``` -------------------------------- ### SetApplyInitialSorting Method Source: https://github.com/dotnet/datagridextensions/blob/master/docs/html/adfe8613-2d62-13b0-dd29-14bc87e099c1.htm Sets a flag to enable the 'apply initial sorting' feature. This is a public static method. ```APIDOC ## SetApplyInitialSorting ### Description Sets a flag to enable the 'apply initial sorting' feature. ### Method Public Static Method ### Parameters None explicitly documented. ### Response Details not provided in the source. ``` -------------------------------- ### DataGridColumnStyle Properties Source: https://github.com/dotnet/datagridextensions/blob/master/docs/html/eb15f0ea-1cc3-82af-d327-0ffcd3ec8d2d.htm Exposes properties to get or set styles for DataGrid columns. ```APIDOC ## DataGridColumnStyle Properties ### Description Provides access to properties that define the styling for DataGrid columns. ### Properties - **ColumnType** (Type): Gets or sets the type of the column for which to set the styles. - **EditingElementStyle** (Style): Gets or sets the editing element style for the column. - **ElementStyle** (Style): Gets or sets the element style for the column. ``` -------------------------------- ### GetApplyInitialSorting Method Signature (VB) Source: https://github.com/dotnet/datagridextensions/blob/master/docs/html/3ed3502d-1615-f795-49ca-b1055d4a92cb.htm This is the Visual Basic signature for the GetApplyInitialSorting method. It is an extension method for DataGrid. ```vb Public Shared Function GetApplyInitialSorting ( dataGrid As DataGrid ) As Boolean ``` -------------------------------- ### Subscribe to Additional Column Events Source: https://github.com/dotnet/datagridextensions/wiki/Additional Events Initialize the data grid and subscribe to events for column visibility, actual width, and display index changes. Ensure the DataGridExtensions library is referenced. ```csharp void Initialize(DataGrid dataGrid) { var dataGridEvents= dataGrid.GetAdditionalEvents(); dataGridEvents.ColumnVisibilityChanged += DataGrid_ColumnVisibilityChanged; dataGridEvents.ColumnActualWidthChanged += DataGrid_ColumnActualWidthChanged; dataGridEvents.ColumnDisplayIndexChanged += DataGrid_ColumnDisplayIndexChanged; } ``` -------------------------------- ### GetContentFilterFactory Method Source: https://github.com/dotnet/datagridextensions/blob/master/docs/html/e2018725-c07b-f5aa-1656-8296825167f8.htm Gets the content filter factory for the data grid filter. ```APIDOC ## GetContentFilterFactory ### Description Gets the content filter factory for the data grid filter. ### Method `public static IContentFilterFactory GetContentFilterFactory(this DataGrid dataGrid)` ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response - **IContentFilterFactory** - The IContentFilterFactory ### Response Example None ### Usage Note In Visual Basic and C#, you can call this method as an instance method on any object of type DataGrid. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide). ### See Also - [DataGridFilter Class](b4d076b6-863c-0c1c-c72e-c53467111da3.htm) - [DataGridExtensions Namespace](5049f02f-0515-9f53-1245-801b61a5c286.htm) ``` -------------------------------- ### SimpleContentFilterFactory Constructors Source: https://github.com/dotnet/datagridextensions/blob/master/docs/html/247836b4-6684-cfc8-d23c-b79799dd6239.htm Initializes a new instance of the SimpleContentFilterFactory class. ```APIDOC ## SimpleContentFilterFactory() ### Description Initializes a new instance of the SimpleContentFilterFactory class. ### Method Constructor ### Parameters None ### Response None ## SimpleContentFilterFactory(StringComparison) ### Description Initializes a new instance of the SimpleContentFilterFactory class. ### Method Constructor ### Parameters * **StringComparison** (StringComparison) - Description of the string comparison to be used. ### Response None ``` -------------------------------- ### FilterColumnControls Property Source: https://github.com/dotnet/datagridextensions/blob/master/docs/html/080ed406-6665-00ff-d244-afb44e028a46.htm Gets a the active filter column controls for this data grid. ```APIDOC ## FilterColumnControls Property ### Description Gets a the active filter column controls for this data grid. ### Property Type [FilterColumnControls](7e81693e-5db6-6622-a1a6-2f4a2580d6f0.htm) ``` -------------------------------- ### RegexContentFilterFactory Constructor Syntax Source: https://github.com/dotnet/datagridextensions/blob/master/docs/html/91647fce-b538-23c5-a023-ccc587608bab.htm Provides the C# and VB.NET syntax for initializing a new instance of the RegexContentFilterFactory class. ```csharp public RegexContentFilterFactory() ``` ```vbnet Public Sub New ``` -------------------------------- ### GetFilterEvaluationDelay Source: https://github.com/dotnet/datagridextensions/blob/master/docs/html/01ca3407-8592-6dc7-a39a-fe066cd0b596.htm Gets the delay that is used to throttle filter changes before the filter is applied. ```APIDOC ## GetFilterEvaluationDelay ### Description Gets the delay that is used to throttle filter changes before the filter is applied. ### Method GET ### Endpoint Not applicable (SDK method) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response - **Return Value** (TimeSpan) - The throttle delay. #### Response Example None ``` -------------------------------- ### SimpleContentFilterFactory(StringComparison) Source: https://github.com/dotnet/datagridextensions/blob/master/docs/html/77dbbe6c-4804-7f1e-bab6-69373934cec7.htm Initializes a new instance of the SimpleContentFilterFactory class with a specified string comparison type. ```APIDOC ## SimpleContentFilterFactory(StringComparison) ### Description Initializes a new instance of the [SimpleContentFilterFactory](247836b4-6684-cfc8-d23c-b79799dd6239.htm) class using a specified string comparison option. ### Method Constructor ### Parameters * **stringComparison** (StringComparison) - Specifies how strings should be compared. ### Response Initializes the SimpleContentFilterFactory object with the provided string comparison settings. ``` -------------------------------- ### GetFilterHost Source: https://github.com/dotnet/datagridextensions/blob/master/docs/html/cc6f7672-4a80-3efd-d9cb-242e0b7d5cb3.htm Gets the filter host for the data grid of this column. This is a public static method. ```APIDOC ## GetFilterHost ### Description Gets the filter host for the data grid of this column. ### Method Public static method ### Endpoint N/A (Method call) ### Parameters N/A ### Request Example N/A ### Response - **filter host** (type unknown) - Description of the filter host ``` -------------------------------- ### DataGridColumnStyleCollection Constructor Source: https://github.com/dotnet/datagridextensions/blob/master/docs/html/76ba6ffa-fe45-aaeb-8512-847cb78bd438.htm Initializes a new instance of the DataGridColumnStyleCollection class. ```APIDOC ## DataGridColumnStyleCollection Constructor ### Description Initializes a new instance of the [DataGridColumnStyleCollection](980a686f-884a-c495-0566-bfd9f0854719.htm) class. ### Syntax ```csharp public DataGridColumnStyleCollection() ``` ### See Also - [DataGridColumnStyleCollection Class](980a686f-884a-c495-0566-bfd9f0854719.htm) - [DataGridExtensions Namespace](5049f02f-0515-9f53-1245-801b61a5c286.htm) ``` -------------------------------- ### ClearTextBoxOnButtonClickBehavior.TextBox Property Source: https://github.com/dotnet/datagridextensions/blob/master/docs/html/afb97760-1682-690c-46b1-4d3d24a0214b.htm Gets or sets the text box to clear. This property is of type System.Windows.Controls.TextBox. ```APIDOC ## ClearTextBoxOnButtonClickBehavior.TextBox Property ### Description Gets or sets the text box to clear. ### Property Type System.Windows.Controls.TextBox ### Syntax ```csharp public TextBox TextBox { get; set; } ``` ```vb Public Property TextBox As TextBox Get Set ``` ``` -------------------------------- ### DataGridColumnStyleCollection Constructor Source: https://github.com/dotnet/datagridextensions/blob/master/docs/html/980a686f-884a-c495-0566-bfd9f0854719.htm Initializes a new instance of the DataGridColumnStyleCollection class. ```APIDOC ## DataGridColumnStyleCollection Constructor ### Description Initializes a new instance of the DataGridColumnStyleCollection class. ### Syntax ```csharp public DataGridColumnStyleCollection() ``` ```vb Public Sub New() ``` ``` -------------------------------- ### RegexContentFilterFactory Constructor (RegexOptions) Source: https://github.com/dotnet/datagridextensions/blob/master/docs/html/ebf29aaf-065f-4f7b-1022-bbc1e3f4fd3c.htm Initializes a new instance of the RegexContentFilterFactory class using the specified regex options. ```APIDOC ## RegexContentFilterFactory Constructor (RegexOptions) ### Description Initializes a new instance of the [RegexContentFilterFactory](5aabb85a-4d59-3cb8-d82f-a07bedc1eb6b.htm) class. ### Parameters #### Parameters - **regexOptions** (System.Text.RegularExpressions.RegexOptions) - The regex options. ### See Also - [RegexContentFilterFactory Class](5aabb85a-4d59-3cb8-d82f-a07bedc1eb6b.htm) - [RegexContentFilterFactory Overload](8efa3056-ff8d-e0d4-9466-f967628bb91f.htm) - [DataGridExtensions Namespace](5049f02f-0515-9f53-1245-801b61a5c286.htm) ``` -------------------------------- ### SimpleContentFilterFactory Constructor Source: https://github.com/dotnet/datagridextensions/blob/master/docs/html/72c4df81-12fa-3adc-1716-40fdda9dc768.htm Initializes a new instance of the SimpleContentFilterFactory class. This is a parameterless constructor. ```APIDOC ## SimpleContentFilterFactory Constructor ### Description Initializes a new instance of the [SimpleContentFilterFactory](247836b4-6684-cfc8-d23c-b79799dd6239.htm) class. ### Syntax ```csharp public SimpleContentFilterFactory() ``` ### See Also - [SimpleContentFilterFactory Class](247836b4-6684-cfc8-d23c-b79799dd6239.htm) - [SimpleContentFilterFactory Overload](77dbbe6c-4804-7f1e-bab6-69373934cec7.htm) - [DataGridExtensions Namespace](5049f02f-0515-9f53-1245-801b61a5c286.htm) ``` -------------------------------- ### MultipleChoiceFilter.Values Property Source: https://github.com/dotnet/datagridextensions/blob/master/docs/html/a3624078-10ff-4678-6d3c-6a3b4b6462a5.htm Gets the collection of values for the MultipleChoiceFilter. This property returns an IList of strings. ```APIDOC ## MultipleChoiceFilter.Values Property ### Description Gets the values. ### Syntax #### C# ```csharp public IList Values { get; } ``` #### VB ```vb Public ReadOnly Property Values As IList(Of String) Get End Property ``` ### Property Value Type: IList ### See Also * [MultipleChoiceFilter Class](7482dac9-ebcc-6415-2a1c-1fa772dc7d50.htm) * [DataGridExtensions Namespace](5049f02f-0515-9f53-1245-801b61a5c286.htm) ``` -------------------------------- ### BeginEditOnCtrlEnterBehavior Constructor Source: https://github.com/dotnet/datagridextensions/blob/master/docs/html/067e2b53-d51e-0cae-cc7a-bcc0d8a92131.htm Initializes a new instance of the BeginEditOnCtrlEnterBehavior class. ```APIDOC ## BeginEditOnCtrlEnterBehavior Constructor ### Description Initializes a new instance of the [BeginEditOnCtrlEnterBehavior](db5064cf-03e9-abc2-8646-1c4f46e18dcf.htm) class. ### Syntax ```csharp public BeginEditOnCtrlEnterBehavior() ``` ```vb Public Sub New ``` ### See Also - [BeginEditOnCtrlEnterBehavior Class](db5064cf-03e9-abc2-8646-1c4f46e18dcf.htm) - [DataGridExtensions.Behaviors Namespace](1bd337c0-1e3a-e5af-76c4-b33120ad52ec.htm) ``` -------------------------------- ### SimpleContentFilter Constructor Source: https://github.com/dotnet/datagridextensions/blob/master/docs/html/5af8e783-3cad-6bca-3619-bf5d53b293a4.htm Initializes a new instance of the SimpleContentFilter class with the specified content and string comparison. ```APIDOC ## SimpleContentFilter Constructor ### Description Initializes a new instance of the [SimpleContentFilter](957f7e42-521f-15a7-eec3-73717ae81cd9.htm) class. ### Parameters #### Parameters - **content** (string) - The content. - **stringComparison** (StringComparison) - The string comparison. ``` -------------------------------- ### GetForceCommitOnLostFocus Source: https://github.com/dotnet/datagridextensions/blob/master/docs/html/4731ecee-fb8d-1d19-2f77-168992f284b2.htm Gets a value that indicates if a commit will be forced on the data grid when it looses the focus. ```APIDOC ## GetForceCommitOnLostFocus ### Description Gets a value that indicates if a commit will be forced on the data grid when it looses the focus. ### Method GET ### Endpoint N/A (This is a method call, not an HTTP endpoint) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example ```csharp // Example usage in C# bool forceCommit = Tools.GetForceCommitOnLostFocus(myGrid); ``` ### Response #### Success Response - **return value** (Boolean) - true if a commit will be forced for the data grid when it looses the focus #### Response Example ```json { "returnValue": true } ``` ``` -------------------------------- ### GetAdditionalEvents Source: https://github.com/dotnet/datagridextensions/blob/master/docs/html/0ede623c-0ef5-3d11-dbaf-bff1fd8e8d25.htm Gets additional events for a data grid. This is an extension method for the DataGrid class. ```APIDOC ## GetAdditionalEvents ### Description Gets additional events for a data grid. ### Method Extension Method ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response - **Return Value** (IDataGridEventsProvider) - The event provider. ### Response Example None ### Usage Note In Visual Basic and C#, you can call this method as an instance method on any object of type DataGrid. When you use instance method syntax to call this method, omit the first parameter. ``` -------------------------------- ### DataGridColumnStyleCollection Constructor Source: https://github.com/dotnet/datagridextensions/blob/master/docs/html/76ba6ffa-fe45-aaeb-8512-847cb78bd438.htm Initializes a new instance of the DataGridColumnStyleCollection class. This is the default constructor. ```csharp public DataGridColumnStyleCollection() ``` -------------------------------- ### SetApplyInitialSorting Source: https://github.com/dotnet/datagridextensions/blob/master/docs/html/983449ff-f4d0-4e2b-9a75-3dcee4de9f94.htm This method sets a flag to enable the 'apply initial sorting' feature for a DataGrid. It is an extension method available for DataGrid objects. ```APIDOC ## SetApplyInitialSorting Method ### Description Sets a flag to enable the 'apply initial sorting' feature. ### Method Extension Method (C#) / Shared Sub (VB.NET) ### Endpoint N/A (Instance method for DataGrid) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example ```csharp // C# Example dataGrid.SetApplyInitialSorting(true); ``` ```vb ' VB.NET Example dataGrid.SetApplyInitialSorting(True) ``` ### Response #### Success Response Void (No return value) #### Response Example N/A ``` -------------------------------- ### DataGridColumnStyle Constructor Source: https://github.com/dotnet/datagridextensions/blob/master/docs/html/0c8da416-bf58-2845-c25e-0d94eb3acc88.htm Initializes a new instance of the DataGridColumnStyle class. ```APIDOC ## DataGridColumnStyle Constructor ### Description Initializes a new instance of the [DataGridColumnStyle](62ffc8d2-78b6-08b9-1632-ac7f76223eb7.htm) class. ### Syntax ```csharp public DataGridColumnStyle() ``` ```vb Public Sub New ``` ### See Also - [DataGridColumnStyle Class](62ffc8d2-78b6-08b9-1632-ac7f76223eb7.htm) - [DataGridExtensions Namespace](5049f02f-0515-9f53-1245-801b61a5c286.htm) ``` -------------------------------- ### DataGridColumnStyle Constructor (C#) Source: https://github.com/dotnet/datagridextensions/blob/master/docs/html/0c8da416-bf58-2845-c25e-0d94eb3acc88.htm Initializes a new instance of the DataGridColumnStyle class. This is the default constructor. ```csharp public DataGridColumnStyle() ``` -------------------------------- ### GetActiveFilter Method Source: https://github.com/dotnet/datagridextensions/blob/master/docs/html/829640c4-7c10-3a1b-55c1-b89cc8715017.htm Gets the filter expression of the column. This is an extension method that can be called on any DataGridColumn object. ```APIDOC ## GetActiveFilter Method ### Description Gets the filter expression of the column. ### Method `public static IContentFilter GetActiveFilter(this DataGridColumn column)` ### Parameters #### Path Parameters - **column** (DataGridColumn) - Required - The column. ### Return Value - **IContentFilter** - The filter. ### Usage Note In Visual Basic and C#, you can call this method as an instance method on any object of type DataGridColumn. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide). ``` -------------------------------- ### VB ElementStyle Property Source: https://github.com/dotnet/datagridextensions/blob/master/docs/html/8542558d-fd48-8142-b0aa-4e66f94c9cf7.htm Gets or sets the element style for the column. This is the VB.NET syntax for the property. ```vb Public Property ElementStyle As Style Get Set ``` -------------------------------- ### ExtendedStarSizeBehavior Constructor Source: https://github.com/dotnet/datagridextensions/blob/master/docs/html/600d93eb-3580-eec1-44b8-254560d9a77c.htm Initializes a new instance of the ExtendedStarSizeBehavior class. ```APIDOC ## ExtendedStarSizeBehavior Constructor ### Description Initializes a new instance of the [ExtendedStarSizeBehavior](c17227b8-b8cc-de61-8bb3-517276989a40.htm) class. ### Syntax ```csharp public ExtendedStarSizeBehavior() ``` ### See Also - [ExtendedStarSizeBehavior Class](c17227b8-b8cc-de61-8bb3-517276989a40.htm) - [DataGridExtensions.Behaviors Namespace](1bd337c0-1e3a-e5af-76c4-b33120ad52ec.htm) ``` -------------------------------- ### C# Syntax for ApplyInitialSortingBehavior Constructor Source: https://github.com/dotnet/datagridextensions/blob/master/docs/html/bbfb0d7c-0464-53d5-b394-765d5833fe4b.htm This is the C# syntax for the default constructor of the ApplyInitialSortingBehavior class. It is used to initialize a new instance of the class. ```csharp public ApplyInitialSortingBehavior() ``` -------------------------------- ### C# ElementStyle Property Source: https://github.com/dotnet/datagridextensions/blob/master/docs/html/8542558d-fd48-8142-b0aa-4e66f94c9cf7.htm Gets or sets the element style for the column. This is the C# syntax for the property. ```csharp public Style ElementStyle { get; set; } ``` -------------------------------- ### Column Property Source: https://github.com/dotnet/datagridextensions/blob/master/docs/html/7b65252a-4716-771a-00e3-7b45447db517.htm Gets the column this control is hosting the filter for. This property returns a DataGridColumn object. ```APIDOC ## Column Property Gets the column this control is hosting the filter for. ### Property Value Type: DataGridColumn ### Syntax ```csharp public DataGridColumn Column { get; } ``` ```vb Public ReadOnly Property Column As DataGridColumn Get ``` ``` -------------------------------- ### GetFilter Method Source: https://github.com/dotnet/datagridextensions/blob/master/docs/html/1bdea481-13b3-7ab8-aebe-5f7452dbd232.htm Gets the filter expression of the column. This is an extension method that can be called on any DataGridColumn object. ```APIDOC ## GetFilter Method ### Description Gets the filter expression of the column. ### Method `public static Object GetFilter(this DataGridColumn column)` ### Parameters #### Path Parameters - **column** (DataGridColumn) - Required - The column for which to retrieve the filter expression. ### Return Value - **Object** - The filter expression of the column. ``` -------------------------------- ### DataGridColumnStyle Constructor (VB.NET) Source: https://github.com/dotnet/datagridextensions/blob/master/docs/html/0c8da416-bf58-2845-c25e-0d94eb3acc88.htm Initializes a new instance of the DataGridColumnStyle class. This is the default constructor. ```vbnet Public Sub New ``` -------------------------------- ### ApplyInitialSorting Attached Property Source: https://github.com/dotnet/datagridextensions/blob/master/docs/html/b999f6fa-541e-3b38-fc95-0e544641d941.htm This attached property is a shortcut for the ApplyInitialSortingBehavior. It allows for initial sorting to be applied to the data grid. ```APIDOC ## ApplyInitialSorting Attached Property ### Description This attached property serves as a shortcut for the ApplyInitialSortingBehavior, enabling the application of initial sorting to the data grid. ### Namespace DataGridExtensions ### Assembly DataGridExtensions (in DataGridExtensions.dll) ### Syntax #### C# ```csharp public static readonly System.Windows.DependencyProperty ApplyInitialSortingProperty; public static bool GetApplyInitialSorting(System.Windows.DependencyObject element); public static void SetApplyInitialSorting(System.Windows.DependencyObject element, bool value); ``` #### VB ```vb Public Shared ReadOnly ApplyInitialSortingProperty As System.Windows.DependencyProperty Public Shared Function GetApplyInitialSorting(element As System.Windows.DependencyObject) As Boolean Public Shared Sub SetApplyInitialSorting(element As System.Windows.DependencyObject, value As Boolean) ``` ### Property Value Type: Boolean ### See Also - [Tools Class](90f8ff5d-5eac-1e58-6898-43a71ad12c82.htm) - [DataGridExtensions Namespace](5049f02f-0515-9f53-1245-801b61a5c286.htm) ``` -------------------------------- ### RegexContentFilterFactory Constructor Source: https://github.com/dotnet/datagridextensions/blob/master/docs/html/91647fce-b538-23c5-a023-ccc587608bab.htm Initializes a new instance of the RegexContentFilterFactory class. This is the default constructor. ```APIDOC ## RegexContentFilterFactory Constructor ### Description Initializes a new instance of the [RegexContentFilterFactory](5aabb85a-4d59-3cb8-d82f-a07bedc1eb6b.htm) class. ### Syntax ```csharp public RegexContentFilterFactory() ``` ### See Also - [RegexContentFilterFactory Class](5aabb85a-4d59-3cb8-d82f-a07bedc1eb6b.htm) - [RegexContentFilterFactory Overload](8efa3056-ff8d-e0d4-9466-f967628bb91f.htm) - [DataGridExtensions Namespace](5049f02f-0515-9f53-1245-801b61a5c286.htm) ``` -------------------------------- ### VB Syntax for Target Property Source: https://github.com/dotnet/datagridextensions/blob/master/docs/html/a3e0b400-dba4-20c6-a0d6-cb4d96bfcc4b.htm Gets or sets the target element that will be disabled during editing. This is the VB syntax. ```vbnet Public Property Target As UIElement Get Set ``` -------------------------------- ### C# Syntax for Target Property Source: https://github.com/dotnet/datagridextensions/blob/master/docs/html/a3e0b400-dba4-20c6-a0d6-cb4d96bfcc4b.htm Gets or sets the target element that will be disabled during editing. This is the C# syntax. ```csharp public UIElement Target { get; set; } ``` -------------------------------- ### BeginEditOnCtrlEnterBehavior Constructor Source: https://github.com/dotnet/datagridextensions/blob/master/docs/html/067e2b53-d51e-0cae-cc7a-bcc0d8a92131.htm Initializes a new instance of the BeginEditOnCtrlEnterBehavior class. This constructor is used to create an instance of the behavior. ```csharp public BeginEditOnCtrlEnterBehavior() ``` -------------------------------- ### MultipleChoiceContentFilter.Items Property Source: https://github.com/dotnet/datagridextensions/blob/master/docs/html/02938f95-8217-bd50-bb6a-83c01e9b9ab5.htm Gets the items to filter. This property returns a list of strings that represent the filterable items. ```APIDOC ## MultipleChoiceContentFilter.Items Property ### Description Gets the items to filter. This property returns a list of strings that represent the filterable items. ### Property Value Type: IList ### Syntax #### C# ```csharp public IList Items { get; } ``` #### VB ```vb Public ReadOnly Property Items As IList(Of String) Get End Property ``` ``` -------------------------------- ### ClearTextBoxOnButtonClickBehavior Constructor (C#) Source: https://github.com/dotnet/datagridextensions/blob/master/docs/html/b1339a43-a8c8-70b0-7876-ec4c209f3f3d.htm Initializes a new instance of the ClearTextBoxOnButtonClickBehavior class in C#. ```csharp public ClearTextBoxOnButtonClickBehavior() ``` -------------------------------- ### TextBox Property Source: https://github.com/dotnet/datagridextensions/blob/master/docs/html/ed07a7cb-985f-34c2-53e2-67c23be02c06.htm Gets or sets the text box to clear. This property links the behavior to the target TextBox element. ```APIDOC ## TextBox Property ### Description Gets or sets the text box to clear. ### Syntax ```csharp public TextBox TextBox { get; set; } ``` ```vb Public Property TextBox As TextBox ``` ``` -------------------------------- ### Apply Initial Sorting to DataGrid Columns Source: https://github.com/dotnet/datagridextensions/blob/master/Documentation/topics/Tools.md This XML snippet shows how to enable the 'ApplyInitialSorting' feature for a DataGrid. This ensures that columns with a specified SortDirection are actually sorted when the grid is initialized, fixing a common issue where the sorting mark appears but the data remains unsorted. ```xml ``` -------------------------------- ### RegexContentFilter Constructor Source: https://github.com/dotnet/datagridextensions/blob/master/docs/html/6f2a72e0-9c32-d419-393c-f6408d240783.htm Initializes a new instance of the RegexContentFilter class with the specified regular expression and options. ```APIDOC ## RegexContentFilter Constructor ### Description Initializes a new instance of the [RegexContentFilter](d817b3a5-93fc-fc26-7335-746e2adba7d8.htm) class. ### Syntax ```csharp public RegexContentFilter(string expression, RegexOptions regexOptions) ``` ### Parameters #### Parameters - **expression** (string) - The expression. - **regexOptions** (RegexOptions) - The regex options. ``` -------------------------------- ### GetFilterHost Method Source: https://github.com/dotnet/datagridextensions/blob/master/docs/html/5b9662ed-124c-9c81-ffaf-9cc4c25db850.htm Gets the filter host for the data grid of this column. This is an extension method that can be called on any DataGridColumn object. ```APIDOC ## GetFilterHost Method ### Description Gets the filter host for the data grid of this column. ### Method `static` `DataGridFilterHost` `GetFilterHost`(`DataGridColumn` column) ### Parameters #### Path Parameters - None #### Query Parameters - None #### Request Body - None ### Request Example - Not applicable for this method. ### Response #### Success Response - **column** (`DataGridColumn`) - Required - The column. - **Return Value** (`DataGridFilterHost`) - The DataGridFilterHost. ### Response Example - Not applicable for this method. ### Usage Note In Visual Basic and C#, you can call this method as an instance method on any object of type DataGridColumn. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide). ``` -------------------------------- ### GetVisibleSelectedCells Method Source: https://github.com/dotnet/datagridextensions/blob/master/docs/html/30a4c915-8b41-537f-a724-69e5f405af57.htm Gets the selected cells that are currently within the visible columns of the DataGrid. This is a static extension method. ```APIDOC ## GetVisibleSelectedCells ### Description Gets the selected cells that are in visible columns. ### Method Public Static Method ### Endpoint N/A (Extension Method) ### Parameters None explicitly documented for this method signature. ### Request Example N/A ### Response This method likely returns information about the visible selected cells, possibly their coordinates or content. ``` -------------------------------- ### DataGridFilterColumnControl Constructor Source: https://github.com/dotnet/datagridextensions/blob/master/docs/html/53fe5c1e-99ae-dffe-2bbb-63a76012109d.htm Initializes a new instance of the DataGridFilterColumnControl class. ```APIDOC ## DataGridFilterColumnControl Constructor ### Description Initializes a new instance of the [DataGridFilterColumnControl](98c600b0-3eb7-d2dc-2466-ae2167c0a00d.htm) class. ### Syntax ```csharp public DataGridFilterColumnControl() ``` ### See Also - [DataGridFilterColumnControl Class](98c600b0-3eb7-d2dc-2466-ae2167c0a00d.htm) - [DataGridExtensions Namespace](5049f02f-0515-9f53-1245-801b61a5c286.htm) ```