ClassPagingPanelElement
Represents the visual element for the paging navigation in RadGridView.
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.GridView.dll
Syntax:
public class PagingPanelElement : GridVisualElement, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IBindableComponent, IComponent, IDisposable, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IPrimitiveElement, IShapedElement, IFillElement, IBorderElement, IBoxStyle, IBoxElement, IDrawFillElement, IImageElement, ITextPrimitive, ITextProvider, IGridView, IGridViewEventListener
Inheritance: objectDisposableObjectRadObjectRadElementVisualElementRadComponentElementRadItemUIItemBaseLightVisualElementGridVisualElementPagingPanelElement
Implements:
Inherited Members
Constructors
PagingPanelElement()
Declaration
public PagingPanelElement()
Fields
ButtonDisplayStyleProperty
Declaration
public static RadProperty ButtonDisplayStyleProperty
Field Value
ButtonGlyphSizeProperty
Declaration
public static RadProperty ButtonGlyphSizeProperty
Field Value
FirstPageButtonImageProperty
Declaration
public static RadProperty FirstPageButtonImageProperty
Field Value
LastPageButtonImageProperty
Declaration
public static RadProperty LastPageButtonImageProperty
Field Value
NextPageButtonImageProperty
Declaration
public static RadProperty NextPageButtonImageProperty
Field Value
NumericButtonsCountProperty
Declaration
public static RadProperty NumericButtonsCountProperty
Field Value
PreviousPageButtonImageProperty
Declaration
public static RadProperty PreviousPageButtonImageProperty
Field Value
Properties
ButtonDisplayStyle
Gets or sets a value indicating, whether the buttons will display images or glyphs.
Declaration
public BindingNavigatorButtonDisplayStyle ButtonDisplayStyle { get; set; }
Property Value
ButtonGlyphSize
Gets or sets the font size of the glyphs when ButtonDisplayStyle property is set to Glyph.
ButtonsStripElement
Gets the buttons strip element.
Declaration
public CommandBarStripElement ButtonsStripElement { get; }
Property Value
The buttons strip element.
CommandBar
Gets the command bar element.
Declaration
public RadCommandBarElement CommandBar { get; }
Property Value
The command bar.
CommandBarRowElement
Gets the command bar row element.
Declaration
public CommandBarRowElement CommandBarRowElement { get; }
Property Value
The command bar row element.
DesiredEvents
Gets the event type(s) this listener needs to process.
Declaration
public GridEventType DesiredEvents { get; }
Property Value
Implements
DesiredProcessMode
Gets the event process mode for this instance.
Declaration
public GridEventProcessMode DesiredProcessMode { get; }
Property Value
Implements
FastBackButton
Gets the button that navigates fast in the backward direction.
Declaration
public CommandBarButton FastBackButton { get; }
Property Value
The fast back button.
FastForwardButton
Gets the button that navigates fast in the forward direction.
Declaration
public CommandBarButton FastForwardButton { get; }
Property Value
The fast forward button.
FirstButton
Gets the button that navigates to the first page.
Declaration
public CommandBarButton FirstButton { get; }
Property Value
The first button.
FirstPageButtonImage
Gets or sets the image of the button that navigates to the first page.
Declaration
[TypeConverter(typeof(ImageTypeConverter))]
public Image FirstPageButtonImage { get; set; }
Property Value
The first page button image.
GridViewElement
Gets or the RadGridViewElement that owns this view.
Declaration
public RadGridViewElement GridViewElement { get; }
Property Value
Implements
LastButton
Gets the button that navigates to the last page.
Declaration
public CommandBarButton LastButton { get; }
Property Value
The last button.
LastPageButtonImage
Gets or sets the image of the button that navigates to the last page.
Declaration
[TypeConverter(typeof(ImageTypeConverter))]
public Image LastPageButtonImage { get; set; }
Property Value
The last page button image.
NextButton
Gets the button that navigates to the next page.
Declaration
public CommandBarButton NextButton { get; }
Property Value
The next button.
NextPageButtonImage
Gets or sets the image of the button that navigates next page.
Declaration
[TypeConverter(typeof(ImageTypeConverter))]
public Image NextPageButtonImage { get; set; }
Property Value
The next page button image.
NumberOfPagesLabel
Gets the label that shows the total number of pages.
Declaration
public CommandBarLabel NumberOfPagesLabel { get; }
Property Value
The number of pages label.
NumericButtonsCount
Gets or sets the number of buttons with numbers in the paging panel.
OfPagesLabel
Gets the label that shows the "of" text.
Declaration
public CommandBarLabel OfPagesLabel { get; }
Property Value
The of pages label.
PageLabel
Gets the label that shows the "Page" text.
Declaration
public CommandBarLabel PageLabel { get; }
Property Value
The page label.
PageNumberTextBox
Gets the text box that shows the current page.
Declaration
public CommandBarTextBox PageNumberTextBox { get; }
Property Value
The page number text box.
PreviousButton
Gets the button that navigates to the previous page.
Declaration
public CommandBarButton PreviousButton { get; }
Property Value
The previous button.
PreviousPageButtonImage
Gets or sets the image of the button that navigates to the previous page.
Declaration
[TypeConverter(typeof(ImageTypeConverter))]
public Image PreviousPageButtonImage { get; set; }
Property Value
The previous page button image.
Priority
Gets the priority of the current instance.
Declaration
public EventListenerPriority Priority { get; }
Property Value
Implements
ShowButtonsStripElement
Gets or sets whether the strip element holding the page navigation buttons is visible.
Declaration
public bool ShowButtonsStripElement { get; set; }
Property Value
true if the strip element holding the page navigation buttons is visible; otherwise, false.
ShowFastBackButton
Gets or sets whether the button that navigates fast backward is visible.
Declaration
public bool ShowFastBackButton { get; set; }
Property Value
true if the button that navigates fast backward is visible; otherwise, false.
ShowFastForwardButton
Gets or sets whether the button that navigates fast forward is visible.
Declaration
public bool ShowFastForwardButton { get; set; }
Property Value
true if the button that navigates fast forward is visible; otherwise, false.
ShowFirstButton
Gets or sets whether the button that navigates to the first page is visible.
Declaration
public bool ShowFirstButton { get; set; }
Property Value
true if the button that navigates to the first page is visible; otherwise, false.
ShowLastButton
Gets or sets whether the button that navigates to the last page is visible.
Declaration
public bool ShowLastButton { get; set; }
Property Value
true if the button that navigates to the last page is visible; otherwise, false.
ShowNextButton
Gets or sets whether the button that navigates to the next page is visible.
Declaration
public bool ShowNextButton { get; set; }
Property Value
true if the button that navigates to the next page is visible; otherwise, false.
ShowNumericalButtons
Gets or sets whether the buttons that navigate to a concrete page are visible.
Declaration
public bool ShowNumericalButtons { get; set; }
Property Value
true if the buttons that navigate to a concrete page are visible; otherwise, false.
ShowPreviousButton
Gets or sets whether the button that navigates to the previous page is visible.
Declaration
public bool ShowPreviousButton { get; set; }
Property Value
true if the button that navigates to the previous page is visible; otherwise, false.
ShowTextBoxStripElement
Gets or sets whether the strip element holding the page navigation text box is visible.
Declaration
public bool ShowTextBoxStripElement { get; set; }
Property Value
true if the strip element holding the page navigation text box is visible; otherwise, false.
TextBoxStripElement
Gets the text box strip element.
Declaration
public CommandBarStripElement TextBoxStripElement { get; }
Property Value
The text box strip element.
ViewInfo
Gets the GridViewInfo that this view represents.
Declaration
public GridViewInfo ViewInfo { get; }
Property Value
Implements
Methods
AnalyzeQueue(List<GridViewEvent>)
Allows a listener to examine events queue and optionally to remove/add events.
Declaration
public bool AnalyzeQueue(List<GridViewEvent> events)
Parameters
events
List<GridViewEvent>
Returns
True if the listener has actually modified the queue, false otherwise.
Implements
CreateButtonsStripElementChildElements()
Creates the buttons strip element child elements.
Declaration
protected virtual void CreateButtonsStripElementChildElements()
CreateChildElements()
Called by the element when constructed. Allows inheritors to build the element tree.
Declaration
protected override void CreateChildElements()
Overrides
CreateTextBoxStripElementChildElements()
Creates the text box strip element child elements.
Declaration
protected virtual void CreateTextBoxStripElementChildElements()
Detach()
Detaches the view from its owner.
Declaration
public void Detach()
Implements
DisposeManagedResources()
Disposes the managed resources of this instance.
Declaration
protected override void DisposeManagedResources()
Overrides
Focus()
Focuses this instance.
Initialize(RadGridViewElement, GridViewInfo)
Initializes the view with an instance of the GridViewTemplate.
Declaration
public void Initialize(RadGridViewElement gridViewElement, GridViewInfo viewInfo)
Parameters
gridViewElement
An instance of RadGridViewElement.
viewInfo
An instance of GridViewTemplate.
Implements
InitializeFields()
Initializes the fields of the current instance.
Declaration
protected override void InitializeFields()
Overrides
MeasureOverride(SizeF)
Measures the element with the available size.
OnNotifyPropertyChanged(PropertyChangedEventArgs)
Raises the standard .NET PropertyChanged event.
Declaration
protected override void OnNotifyPropertyChanged(PropertyChangedEventArgs e)
Parameters
e
Overrides
OnPropertyChanged(RadPropertyChangedEventArgs)
Handles property change events by invalidating the fill cache and invoking the base class property change handler.
Declaration
protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)
Parameters
e
Event arguments containing information about the property that changed.
Overrides
PostProcessEvent(GridViewEvent)
Allows additional processing of an event that has been just dispatched.
Declaration
public GridViewEventResult PostProcessEvent(GridViewEvent eventData)
Parameters
eventData
Returns
Implements
PreProcessEvent(GridViewEvent)
Allows previewing of an event that is about to be dispatched.
Declaration
public GridViewEventResult PreProcessEvent(GridViewEvent eventData)
Parameters
eventData
Returns
Implements
ProcessEvent(GridViewEvent)
Core entry point for receiving and processing an event.
Declaration
public GridViewEventResult ProcessEvent(GridViewEvent eventData)
Parameters
eventData
Returns
Implements
SetStripButtonsEnabledState()
Sets the enabled state of FirstButton, PreviousButton, FastBackButton, LastButton, NextButton, FastForwardButton, depending on current page index.
Declaration
protected virtual void SetStripButtonsEnabledState()
UnwireEvents()
Unwires the buttons and text box events.
Declaration
protected virtual void UnwireEvents()
UpdateButton(CommandBarButton, string)
Declaration
protected virtual void UpdateButton(CommandBarButton button, string glyph)
Parameters
button
glyph
UpdateButtonsStripElement()
Updates the buttons strip element. Called when an update notification arrives.
Declaration
protected virtual void UpdateButtonsStripElement()
UpdateTextBoxStripElement()
Updates the text box strip element. Called when an update notification arrives.
Declaration
protected virtual void UpdateTextBoxStripElement()
UpdateView()
Explicitly synchronizes the view with its owner.
Declaration
public void UpdateView()
Implements
WireEvents()
Wires the buttons and text box events.
Declaration
protected virtual void WireEvents()