Interface IMultiColumnComboBox
Defines the contract for the Syncfusion Blazor Multi-Column ComboBox component, providing methods for managing child component properties and column configurations.
Namespace: Syncfusion.Blazor.MultiColumnComboBox
Assembly: Syncfusion.Blazor.dll
Syntax
public interface IMultiColumnComboBox
Remarks
The IMultiColumnComboBox interface serves as the primary contract for the Multi-Column ComboBox component, enabling dynamic updates to column properties and configurations. This interface is essential for components that need to programmatically modify column settings, data binding, and display properties at runtime.
Implementing this interface allows for:
- Dynamic column property updates without full component re-rendering
- Programmatic control over column configurations
- Efficient handling of child component property changes
- Integration with data-driven scenarios where column properties may change based on user interactions or data updates
This interface is typically implemented by the SfMultiColumnComboBox component to provide a standardized way of managing column properties and ensuring consistent behavior across different usage scenarios.
Methods
UpdateChildProperties(MultiColumnComboboxColumns)
Asynchronously updates the child properties of the Multi-Column ComboBox component, allowing for dynamic modification of column configurations and display settings.
Declaration
Task UpdateChildProperties(MultiColumnComboboxColumns properties)
Parameters
Type | Name | Description |
---|---|---|
MultiColumnComboboxColumns | properties | The MultiColumnComboboxColumns object containing the updated properties and configurations to be applied to the child component. This parameter must not be null. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | A Task representing the asynchronous operation of updating the child properties. The task completes when all property updates have been successfully applied to the component. |
Remarks
This method provides a mechanism for dynamically updating column properties without requiring a full component refresh. It is particularly useful in scenarios where:
- Column configurations need to be modified based on user interactions
- Data binding properties require updates after data source changes
- Display settings need to be adjusted programmatically
- Performance optimization is required to avoid full component re-rendering
The method operates asynchronously to ensure that UI updates do not block the main thread, providing a smooth user experience even when multiple property updates are being processed simultaneously.
Usage Considerations:
- Ensure the properties parameter contains valid column configurations
- The method should be awaited to ensure all updates are completed before proceeding
- Multiple rapid calls to this method are handled efficiently through internal batching mechanisms
- Property validation is performed internally to prevent invalid configurations
Performance Notes:
- This method is optimized to update only the properties that have actually changed
- Batch updates are more efficient than multiple individual property updates
- The asynchronous nature prevents UI blocking during complex property updates
Exceptions
Type | Condition |
---|---|
System.ArgumentNullException | Thrown when the properties parameter is null. |
System.InvalidOperationException | Thrown when the component is in an invalid state for property updates. |