Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.UI.dll
Syntax:
public class PropertyGridTableElement : VirtualizedScrollPanel<PropertyGridItemBase, PropertyGridItemElementBase>, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IBindableComponent, IComponent, IDisposable, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IPrimitiveElement, IShapedElement, IFillElement, IBorderElement, IBoxStyle, IBoxElement, IDrawFillElement, IImageElement, ITextPrimitive, ITextProvider, IDataItemSourceInheritance: objectDisposableObjectRadObjectRadElementVisualElementRadComponentElementRadItemUIItemBaseLightVisualElementScrollViewElement<VirtualizedStackContainer<PropertyGridItemBase>>VirtualizedScrollPanel<PropertyGridItemBase, PropertyGridItemElementBase>PropertyGridTableElement...
Implements:
Inherited Members
Constructors
public PropertyGridTableElement()Fields
public CreatePropertyGridItemEventHandler CreateItempublic CreatePropertyGridItemElementEventHandler CreateItemElementprotected bool isChangingpublic static RadProperty ItemHeightPropertypublic static RadProperty ItemIndentPropertyProperties
Gets the active editor.
public IValueEditor ActiveEditor { get; }Gets or sets a value indicating whether the groups will be expanded or collapse upon creation.
[Browsable(true)]
public bool AutoExpandGroups { get; set; }Gets or sets a value indicating how user begins editing a cell.
[Browsable(true)]
public RadPropertyGridBeginEditModes BeginEditMode { get; set; }Gets the collection to which the RadPropertyGrid is bound to.
[Browsable(false)]
public RadCollectionView<PropertyGridItem> CollectionView { get; }Gets or sets the context menu.
public virtual RadContextMenu ContextMenu { get; set; }The context menu.
Gets or sets a value indicating whether the data can be grouped programmatically.
[Browsable(true)]
public bool EnableCustomGrouping { get; set; }Gets or sets a value indicating whether the kinetic scrolling function is enabled.
[Browsable(true)]
public bool EnableKineticScrolling { get; set; }Gets the filter descriptors.
[Browsable(false)]
public FilterDescriptorCollection FilterDescriptors { get; }The filter descriptors.
Gets or sets an object that implements IFindStringComparer. The value of this property is used in the keyboard search functionality.
public IFindStringComparer FindStringComparer { get; set; }Gets the group descriptors.
[Browsable(false)]
public GroupDescriptorCollection GroupDescriptors { get; }The group descriptors.
public virtual PropertyGridGroupItemCollection Groups { get; }Gets a value indicating whether there are currently open editors.
[Browsable(false)]
public bool IsEditing { get; }Gets or sets the height of the items.
[Browsable(true)]
public int ItemHeight { get; set; }The height of the item.
Gets or sets the width of the indentation of subitems.
[Browsable(true)]
public int ItemIndent { get; set; }Gets or sets the distance between property grid items.
[Browsable(true)]
public override int ItemSpacing { get; set; }Overrides:
Gets or sets a value that determines whether the user can navigate to an item by typing when RadPropertyGrid is focused. The default value is false.
public bool KeyboardSearchEnabled { get; set; }Gets or sets a value that specifies how long the user must wait before searching with the keyboard is reset. The default value is 300.
public int KeyboardSearchResetInterval { get; set; }public RadListSource<PropertyGridItem> ListSource { get; }Gets or sets the minimum width columns can have.
[Browsable(true)]
public int MinimumColumnWidth { get; set; }Gets or sets a value that indicates whether editors specified with an EditorAttribute will be used without considering built-in editors.
[Browsable(true)]
public bool OverrideBuiltInEditors { get; set; }Gets the PropertyGridElement that is a parent to this element.
public PropertyGridElement PropertyGridElement { get; }public virtual PropertyGridRootItemsCollection PropertyItems { get; }Gets or sets the mode in which the properties will be displayed in the PropertyGridTableElement.
[Browsable(true)]
public PropertySort PropertySort { get; set; }Gets or sets a value indicating whether the user is allowed to edit the values of the properties.
[Browsable(true)]
public bool ReadOnly { get; set; }Gets the ScrollServiceBehavior that is responsible for the kinetic scrolling option.
public ScrollServiceBehavior ScrollBehavior { get; }Gets the PropertyGridTableElement selected item.
public PropertyGridItemBase SelectedGridItem { get; set; }Gets or sets the object which properties the RadPropertyGrid is displaying.
[Browsable(false)]
public object SelectedObject { get; set; }Gets or sets the objects which properties the RadPropertyGrid is displaying.
[Browsable(false)]
public object[] SelectedObjects { get; set; }Gets the sort descriptors.
[Browsable(false)]
public SortDescriptorCollection SortDescriptors { get; }The sort descriptors.
Gets or sets the sort order of Nodes.
[Browsable(false)]
public SortOrder SortOrder { get; set; }The sort order.
Gets or sets a value indicating whether the values of the items should be invalidated the next time a grouping and/or sorting is performed.
[Browsable(false)]
public virtual bool UseCachedValues { get; set; }Gets or sets the width of the "column" that holds the values.
[Browsable(true)]
public int ValueColumnWidth { get; set; }Methods
Puts the current item in edit mode.
Begins the update.
public void BeginUpdate()Uses a mechanism to maximize the visible strings in both columns of RadPropertyGrid.
public void BestFit()Best fits the column(s) of RadPropertyGrid using the given mode.
public void BestFit(PropertyGridBestFitMode mode)The mode that determines the mechanism used for best fitting.
public void BindingComplete()Implements:
Close the currently active editor and discard changes.
public void CancelEdit()Called by the element when constructed. Allows inheritors to build the element tree.
protected override void CreateChildElements()Overrides:
This method creates an object that implements IVirtualizedElementProvider. Child elements are not yet created in this method.
protected override IVirtualizedElementProvider<PropertyGridItemBase> CreateElementProvider()IVirtualizedElementProvider<PropertyGridItemBase>
A new instance of an implementation of IVirtualizedElementProvider.
Overrides:
Disposes of managed resources including cached images and SVG images when the element is being disposed.
protected override void DisposeManagedResources()Overrides:
Commits any changes and ends the edit operation on the current item.
Ends the update.
public void EndUpdate()Ends the update.
public void EndUpdate(bool performUpdate, PropertyGridTableElement.UpdateActions action)Tells the view whether an update is required or not.
actionPropertyGridTableElement.UpdateActionsIndicates the update action
Ensures the item is visible within the RadPropertygridElement and scrolls the element if needed.
public void EnsureVisible(PropertyGridItemBase item)The item to visualize.
Ensures the item is visible within the RadPropertygridElement and scrolls the element if needed.
protected virtual void EnsureVisibleCore(PropertyGridItemBase item)The item to visualize.
Gets an editor depending on the type of the value to be edited.
protected virtual IInputEditor GetEditor(Type editorType)The type of the value.
Returns:Gets the type of editor used for a editing the given item.
protected virtual Type GetEditorTypeForItem(PropertyGridItem item)The item to get editor type for.
Returns:The type of the editor
Gets the element at specified coordinates.
public PropertyGridItemElementBase GetElementAt(int x, int y)The x coordinate.
yintThe y coordinate.
Returns:An instance of PropertyGridItemBase if successful.
Initializes and returns the context menu associated with the specified PropertyGridItemElementBase.
public RadContextMenu GetElementContextMenu(PropertyGridItemElementBase element)The element.
Returns:An instance of RadContextMenu if successfull.
This method traverses through the visible items of RadPropetyGrid and returns an item matching the searchCriteria.
protected virtual PropertyGridItemBase GetFirstMatch(string searchCriteria, IList<PropertyGridItem> items)Gets the default property for the selected object
protected virtual PropertyGridItem GetSelectedObjectDefaultProperty()The PropertyGridItem that is the default property.
public void Initialize()Implements:
Initializes the internal fields and components of the LightVisualElement. This method sets up text primitives, image primitives, and layout management components.
protected override void InitializeFields()Overrides:
Returns a value indicating whether the PropertyGridItem is editable
protected virtual bool IsItemEditable(PropertyGridItem item)The item to check.
Returns:True if item can be edited. Otherwise false.
Measures the desired size of the element by calculating the space needed for content, padding, and borders.
public IDataItem NewItem(PropertyGridItem parentItem)Called when auto size is changed.
protected override void OnAutoSizeChanged()Overrides:
protected virtual void OnContextMenuOpening(PropertyGridContextMenuOpeningEventArgs e)protected virtual void OnCreateItem(CreatePropertyGridItemEventArgs e)protected virtual void OnCreateItemElement(CreatePropertyGridItemElementEventArgs e)protected virtual void OnCustomGrouping(PropertyGridCustomGroupingEventArgs e)protected virtual void OnEdited(PropertyGridItemEditedEventArgs e)protected virtual void OnEditing(PropertyGridItemEditingEventArgs e)protected virtual void OnEditorInitialized(PropertyGridItemEditorInitializedEventArgs e)protected virtual void OnEditorRequired(PropertyGridEditorRequiredEventArgs e)protected virtual void OnItemExpandedChanged(RadPropertyGridEventArgs e)protected virtual void OnItemExpandedChanging(RadPropertyGridCancelEventArgs e)protected virtual void OnItemFormatting(PropertyGridItemFormattingEventArgs e)protected virtual void OnItemMouseClick(RadPropertyGridEventArgs e)protected virtual void OnItemMouseDoubleClick(RadPropertyGridEventArgs e)protected virtual void OnItemMouseDown(PropertyGridMouseEventArgs e)protected virtual void OnItemMouseMove(PropertyGridMouseEventArgs e)Called when the element has been successfully loaded. That includes loading of all its children as well.
protected override void OnLoaded()Overrides:
Fires the PanGesture event.
protected override void OnPanGesture(PanGestureEventArgs args)The arguments for the PanGesture event.
Overrides:
Handles property change events by invalidating the fill cache and invoking the base class property change handler.
protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)Event arguments containing information about the property that changed.
Overrides:
protected virtual void OnPropertyValidated(PropertyValidatedEventArgs e)protected virtual void OnPropertyValidating(PropertyValidatingEventArgs e)protected virtual void OnPropertyValueChanged(PropertyGridItemValueChangedEventArgs e)protected virtual void OnPropertyValueChanging(PropertyGridItemValueChangingEventArgs e)protected virtual void OnSelectedGridItemChanged(RadPropertyGridEventArgs args)protected virtual void OnSelectedGridItemChanging(RadPropertyGridCancelEventArgs args)protected virtual void OnSelectedObjectChanged(PropertyGridSelectedObjectChangedEventArgs e)protected virtual void OnSelectedObjectChanging(PropertyGridSelectedObjectChangingEventArgs e)protected virtual void OnValueChanging(object sender, ValueChangingEventArgs e)Performs the needed operations on the data layer when the PropertySort mode is changed.
protected virtual void PerformPropertySort(PropertySort propertySort)protected virtual bool ProcessKeyPress(KeyPressEventArgs e)protected virtual bool ProcessSelection(PropertyGridItemBase item, bool isMouseSelection)Allows you to raise ValueChanged event when using custom editor.
Allows you to raise ValueChanging event when using custom editor.
Makes the property grid columns even.
public void ResetColumnWidths()Scrolls the scrollbar to bring the specified PropertyGridItemBase into view.
public void ScrollToItem(PropertyGridItemBase item)The item to visualize.
Sorts the sub items of all expanded items.
public virtual void SortSubItems()Syncronizes all visual elements.
protected virtual void SynchronizeVisualItems()Performs events unsubscription from internal objects. The base implementation must always be called.
protected override void UnwireEvents()Overrides:
Updates the visual items in the property grid
public void Update(PropertyGridTableElement.UpdateActions updateAction)Indicated the update action
Updates the scroll bars visibility.
Specifies the action which caused the update.protected virtual void UpdateScrollers(PropertyGridTableElement.UpdateActions updateAction)Performs events subscription to internal objects. The base implementation must always be called.
protected override void WireEvents()Overrides:
Events
Occurs when [binding context changed].
public event EventHandler BindingContextChangedImplements:
public event PropertyGridContextMenuOpeningEventHandler ContextMenuOpeningFires for custom grouping operation.
[Browsable(true)]
public event PropertyGridCustomGroupingEventHandler CustomGroupingOccurs when editing has been finished.
public event PropertyGridItemEditedEventHandler EditedOccurs when editing is started.
public event PropertyGridItemEditingEventHandler EditingOccurs when editor is initialized.
public event PropertyGridItemEditorInitializedEventHandler EditorInitializedOccurs when editor is required.
public event PropertyGridEditorRequiredEventHandler EditorRequiredOccurs when item has been expanded.
public event RadPropertyGridEventHandler ItemExpandedChangedOccurs when item is expanding.
public event RadPropertyGridCancelEventHandler ItemExpandedChangingOccurs when PropertyGridItemElement is formatting
public event PropertyGridItemFormattingEventHandler ItemFormattingOccurs when a mouse button is clicked inside a PropertyGridItemElementBase
public event RadPropertyGridEventHandler ItemMouseClickOccurs when a mouse button is double clicked inside a PropertyGridItemElementBase
public event RadPropertyGridEventHandler ItemMouseDoubleClickOccurs when a mouse button is pressed on the PropertyGridItemElement.
public event PropertyGridMouseEventHandler ItemMouseDownOccurs when mouse moves over a PropertyGridItemElement.
public event PropertyGridMouseEventHandler ItemMouseMoveFires when a peoperty has finished validating.
public event PropertyValidatedEventHandler PropertyValidatedFires when a property value is validating.
public event PropertyValidatingEventHandler PropertyValidatingOccurs when item's value has been changed.
public event PropertyGridItemValueChangedEventHandler PropertyValueChangedOccurs when item's value is changing.
public event PropertyGridItemValueChangingEventHandler PropertyValueChangingOccurs when selected item has been changed.
public event RadPropertyGridEventHandler SelectedGridItemChangedOccurs when the selected item is changing
public event RadPropertyGridCancelEventHandler SelectedGridItemChangingOccurs after the property grid selected object has been changed.
public event PropertyGridSelectedObjectChangedEventHandler SelectedObjectChangedOccurs before the selected object is changed.
public event PropertyGridSelectedObjectChangingEventHandler SelectedObjectChangingFires when the value of an editor changes.
public event EventHandler ValueChangedFires before the value in an editor is being changed. The action can be canceled.
public event ValueChangingEventHandler ValueChanging