Back to Devexpress

SpreadsheetControl Properties

wpf-devexpress-dot-xpf-dot-spreadsheet-dot-spreadsheetcontrol-dot-underscore-properties.md

latest62.3 KB
Original Source

SpreadsheetControl Properties

Emulates the Microsoft® Excel® look and feel and allows you to create, load, edit, save and print spreadsheet documents.

NameDescription
AcceptsEscapeGets or sets a value indicating whether pressing the ESC key is processed by the SpreadsheetControl. This is a dependency property.
AcceptsReturnGets or sets a value indicating whether pressing the RETURN key is processed by the SpreadsheetControl. This is a dependency property.
AcceptsTabGets or sets a value indicating whether pressing the TAB key is processed by the SpreadsheetControl instead of moving the focus to the next control in the tab order. This is a dependency property.
ActiveCellGets an active cell in the active worksheet.
ActiveChartSheetGets the chart sheet that is currently displayed in the SpreadsheetControl.
ActiveSheetGets the sheet that is currently displayed in the SpreadsheetControl.
ActiveSheetIndexGets or sets the index of an active worksheet. This is a dependency property.
ActiveSheetNameGets or sets the name of an active worksheet. This is a dependency property.
ActiveViewProvides access to a View object that contains layout information.
ActiveViewZoomGets or sets the zoom level for the sheet currently displayed in the SpreadsheetControl. This is a dependency property.
ActiveWorksheetGets the worksheet that is currently displayed in the SpreadsheetControl.
ActualHeightGets the rendered height of this element. Inherited from FrameworkElement.
ActualWidthGets the rendered width of this element. Inherited from FrameworkElement.
AllowDropGets or sets a value indicating whether this element can be used as the target of a drag-and-drop operation. This is a dependency property. Inherited from UIElement.
AreAnyTouchesCapturedGets a value that indicates whether at least one touch is captured to this element. Inherited from UIElement.
AreAnyTouchesCapturedWithinGets a value that indicates whether at least one touch is captured to this element or to any child elements in its visual tree. Inherited from UIElement.
AreAnyTouchesDirectlyOverGets a value that indicates whether at least one touch is pressed over this element. Inherited from UIElement.
AreAnyTouchesOverGets a value that indicates whether at least one touch is pressed over this element or any child elements in its visual tree. Inherited from UIElement.
BackgroundGets or sets a brush that describes the background of a control. Inherited from Control.
BarManagerGets or sets the main component that provides Bars functionality. This is a dependency property.
BindingGroupGets or sets the BindingGroup that is used for the element. Inherited from FrameworkElement.
BitmapEffectGets or sets a bitmap effect that applies directly to the rendered content for this element. This is a dependency property. Inherited from UIElement.
BitmapEffectInputGets or sets an input source for the bitmap effect that applies directly to the rendered content for this element. This is a dependency property. Inherited from UIElement.
BorderBrushGets or sets a brush that describes the border background of a control. Inherited from Control.
BorderThicknessGets or sets the border thickness of a control. Inherited from Control.
CacheModeGets or sets a cached representation of the UIElement. Inherited from UIElement.
CellTemplateGets or sets the template used to visualize worksheet cells. This is a dependency property.
CellTemplateSelectorGets or sets an object that selects a cell template based on custom logic. This is a dependency property.
CellToolTipGets or sets the cell tooltip. This is a dependency property.
ChartLayoutGalleryGroupsGets or sets Chart Gallery Ribbon groups in the Ribbon UI. For internal use. This is a dependency property.
ChartStyleGalleryGroupsGets or sets the Chart Styles gallery groups in the Ribbon UI. For internal use. This is a dependency property.
ChartStylePopupGalleryGroupsGets or sets the Chart Styles dropdown gallery groups in the Ribbon UI. For internal use. This is a dependency property.
ClipGets or sets the geometry used to define the outline of the contents of an element. This is a dependency property. Inherited from UIElement.
ClipboardProvides access to the object used for working with the system clipboard.
ClipToBoundsGets or sets a value indicating whether to clip the content of this element (or content coming from the child elements of this element) to fit into the size of the containing element. This is a dependency property. Inherited from UIElement.
CommandBarStyleGets or sets the command bar for the SpreadsheetControl. This is a dependency property.
CommandBindingsGets a collection of CommandBinding objects associated with this element. A CommandBinding enables command handling for this element, and declares the linkage between a command, its events, and the handlers attached by this element. Inherited from UIElement.
CommandProviderGets or sets the SpreadsheetControl’s command provider. This is a dependency property.
ContextMenuGets or sets the context menu element that should appear whenever the context menu is requested through user interface (UI) from within this element. Inherited from FrameworkElement.
CursorGets or sets the cursor that displays when the mouse pointer is over this element. Inherited from FrameworkElement.
DataContextGets or sets the data context for an element when it participates in data binding. Inherited from FrameworkElement.
DefaultStyleKey protectedGets or sets the key to use to reference the style for this control, when theme styles are used or defined. Inherited from FrameworkElement.
DependencyObjectTypeGets the DependencyObjectType that wraps the CLR type of this instance. Inherited from DependencyObject.
DesiredSizeGets the size that this element computed during the measure pass of the layout process. Inherited from UIElement.
DispatcherGets the Dispatcher this DispatcherObject is associated with. Inherited from DispatcherObject.
DocumentProvides access to a workbook loaded in the control.
DocumentSourceGets or sets a document supplier for a SpreadsheetControl. This is a dependency property.
DpiXGets the current dpi value for the X-coordinate.
DpiYGets the current dpi value for the Y-coordinate.
EffectGets or sets the bitmap effect to apply to the UIElement. This is a dependency property. Inherited from UIElement.
FlowDirectionGets or sets the direction that text and other user interface (UI) elements flow within any parent element that controls their layout. Inherited from FrameworkElement.
FocusableGets or sets a value that indicates whether the element can receive focus. This is a dependency property. Inherited from UIElement.
FocusVisualStyleGets or sets a property that enables customization of appearance, effects, or other style characteristics that will apply to this element when it captures keyboard focus. Inherited from FrameworkElement.
FontFamilyGets or sets the font family of the control. Inherited from Control.
FontSizeGets or sets the font size. Inherited from Control.
FontStretchGets or sets the degree to which a font is condensed or expanded on the screen. Inherited from Control.
FontStyleGets or sets the font style. Inherited from Control.
FontWeightGets or sets the weight or thickness of the specified font. Inherited from Control.
ForceCursorGets or sets a value that indicates whether this FrameworkElement should force the user interface (UI) to render the cursor as declared by the Cursor property. Inherited from FrameworkElement.
ForegroundGets or sets a brush that describes the foreground color. Inherited from Control.
FormulaBarExpandedGets or sets a value indicating whether the integrated formula bar is expanded or collapsed. This is a dependency property.
FormulaBarNameBoxItemDisplayModeGets or sets a value indicating what items should appear in the Name Box list of the integrated formula bar. This is a dependency property.
FormulaBarShowButtonsGets or sets whether the Cancel , Enter and Insert function buttons are displayed in the integrated formula bar. This is a dependency property.
FormulaBarShowEditorGets or sets whether the formula editor is displayed in the integrated formula bar. This is a dependency property.
FormulaBarShowNameBoxGets or sets whether the Name Box is displayed in the integrated formula bar. This is a dependency property.
GridLinesColorGets or sets the color of the grid lines in the control.This is a dependency property.
HandlesScrolling protectedGets a value that indicates whether a control supports scrolling. Inherited from Control.
HasAnimatedPropertiesGets a value indicating whether this element has any animated properties. Inherited from UIElement.
HasEffectiveKeyboardFocus protectedGets a value that indicates whether the UIElement has focus. Inherited from UIElement.
HeightGets or sets the suggested height of the element. Inherited from FrameworkElement.
HorizontalAlignmentGets or sets the horizontal alignment characteristics applied to this element when it is composed within a parent element, such as a panel or items control. Inherited from FrameworkElement.
HorizontalContentAlignmentGets or sets the horizontal alignment of the control’s content. Inherited from Control.
HorizontalScrollBarProvides access to a horizontal scroll bar of the SpreadsheetControl.
HorizontalScrollbarVisibilityGets or sets a value that indicates whether the SpreadsheetControl’s scrollbar should be displayed or hidden. This is a dependency property.
InheritanceBehavior protectedGets or sets the scope limits for property value inheritance, resource key lookup, and RelativeSource FindAncestor lookup. Inherited from FrameworkElement.
InputBindingsGets the collection of input bindings associated with this element. Inherited from UIElement.
InputScopeGets or sets the context for input used by this FrameworkElement. Inherited from FrameworkElement.
IsArrangeValidGets a value indicating whether the computed size and position of child elements in this element’s layout are valid. Inherited from UIElement.
IsCellEditorActiveGets whether the cell editor is currently active.
IsEnabledGets or sets a value indicating whether this element is enabled in the user interface (UI). This is a dependency property. Inherited from UIElement.
IsEnabledCore protectedGets a value that becomes the return value of IsEnabled in derived classes. Inherited from UIElement.
IsFocusedGets a value that determines whether this element has logical focus. This is a dependency property. Inherited from UIElement.
IsHitTestVisibleGets or sets a value that declares whether this element can possibly be returned as a hit test result from some portion of its rendered content. This is a dependency property. Inherited from UIElement.
IsInitializedGets a value that indicates whether this element has been initialized, either during processing by a XAML processor, or by explicitly having its EndInit() method called. Inherited from FrameworkElement.
IsInputMethodEnabledGets a value indicating whether an input method system, such as an Input Method Editor (IME), is enabled for processing the input to this element. Inherited from UIElement.
IsKeyboardFocusedGets a value indicating whether this element has keyboard focus. This is a dependency property. Inherited from UIElement.
IsKeyboardFocusWithinGets a value indicating whether keyboard focus is anywhere within the element or its visual tree child elements. This is a dependency property. Inherited from UIElement.
IsLoadedGets a value that indicates whether this element has been loaded for presentation. Inherited from FrameworkElement.
IsManipulationEnabledGets or sets a value that indicates whether manipulation events are enabled on this UIElement. Inherited from UIElement.
IsMeasureValidGets a value indicating whether the current size returned by layout measure is valid. Inherited from UIElement.
IsMouseCapturedGets a value indicating whether the mouse is captured to this element. This is a dependency property. Inherited from UIElement.
IsMouseCaptureWithinGets a value that determines whether mouse capture is held by this element or by child elements in its visual tree. This is a dependency property. Inherited from UIElement.
IsMouseDirectlyOverGets a value that indicates whether the position of the mouse pointer corresponds to hit test results, which take element compositing into account. This is a dependency property. Inherited from UIElement.
IsMouseOverGets a value indicating whether the mouse pointer is located over this element (including child elements in the visual tree). This is a dependency property. Inherited from UIElement.
IsPrintingAvailableIndicates whether the SpreadsheetControl can be printed or exported.
IsPrintPreviewAvailableGets a value indicating whether a preview of the SpreadsheetControl’s document is allowed.
IsSealedGets a value that indicates whether this instance is currently sealed (read-only). Inherited from DependencyObject.
IsStylusCapturedGets a value indicating whether the stylus is captured by this element. This is a dependency property. Inherited from UIElement.
IsStylusCaptureWithinGets a value that determines whether stylus capture is held by this element, or an element within the element bounds and its visual tree. This is a dependency property. Inherited from UIElement.
IsStylusDirectlyOverGets a value that indicates whether the stylus position corresponds to hit test results, which take element compositing into account. This is a dependency property. Inherited from UIElement.
IsStylusOverGets a value indicating whether the stylus cursor is located over this element (including visual child elements). This is a dependency property. Inherited from UIElement.
IsTabStopGets or sets a value that indicates whether a control is included in tab navigation. Inherited from Control.
IsUpdateLockedReturns a value indicating whether the SpreadsheetControl is locked for update.
IsVisibleGets a value indicating whether this element is visible in the user interface (UI). This is a dependency property. Inherited from UIElement.
LanguageGets or sets localization/globalization language information that applies to an element. Inherited from FrameworkElement.
LayoutTransformGets or sets a graphics transformation that should apply to this element when layout is performed. Inherited from FrameworkElement.
LayoutUnitGets or sets a unit of measure used for a document layout. This is a dependency property.
LayoutViewBoundsGets the bounds of the control’s viewport in Layout view (for resolutions specified by the SpreadsheetControl.DpiX and SpreadsheetControl.DpiY properties).
MarginGets or sets the outer margin of an element. Inherited from FrameworkElement.
MaxHeightGets or sets the maximum height constraint of the element. Inherited from FrameworkElement.
MaxWidthGets or sets the maximum width constraint of the element. Inherited from FrameworkElement.
MenuCustomizationsAllows you to customize the Spreadsheet control’s context menus. This is a dependency property.
MinHeightGets or sets the minimum height constraint of the element. Inherited from FrameworkElement.
MinWidthGets or sets the minimum width constraint of the element. Inherited from FrameworkElement.
ModifiedGets or sets a value that indicates that the SpreadsheetControl content was modified since it was last saved. This is a dependency property.
NameGets or sets the identifying name of the element. The name provides a reference so that code-behind, such as event handler code, can refer to a markup element after it is constructed during processing by a XAML processor. Inherited from FrameworkElement.
OpacityGets or sets the opacity factor applied to the entire UIElement when it is rendered in the user interface (UI). This is a dependency property. Inherited from UIElement.
OpacityMaskGets or sets an opacity mask, as a Brush implementation that is applied to any alpha-channel masking for the rendered content of this element. This is a dependency property. Inherited from UIElement.
OptionsProvides access to different options which can be specified for the document loaded into the SpreadsheetControl and for the control itself. This is a dependency property.
OverridesDefaultStyleGets or sets a value that indicates whether this element incorporates style properties from theme styles. Inherited from FrameworkElement.
PaddingGets or sets the padding inside a control. Inherited from Control.
ParentGets the logical parent element of this element. Inherited from FrameworkElement.
PersistIdGets a value that uniquely identifies this element. Inherited from UIElement.
PivotTableStyleGalleryGroupsGets or sets the PivotTable Styles gallery groups in the Ribbon UI. For internal use. This is a dependency property.
PivotTableStylePopupGalleryGroupsGets or sets the PivotTable Styles dropdown gallery groups in the Ribbon UI. For internal use. This is a dependency property.
ReadOnlyGets or sets whether document modifications are prohibited. This is a dependency property.
RenderSizeGets (or sets) the final render size of this element. Inherited from UIElement.
RenderTransformGets or sets transform information that affects the rendering position of this element. This is a dependency property. Inherited from UIElement.
RenderTransformOriginGets or sets the center point of any possible render transform declared by RenderTransform, relative to the bounds of the element. This is a dependency property. Inherited from UIElement.
ResourcesGets or sets the locally-defined resource dictionary. Inherited from FrameworkElement.
RibbonGets or sets the RibbonControl associated with the current SpreadsheetControl instance. This is a dependency property.
RibbonActionsProvides access to the collection of actions used to customize the SpreadhseetControl’s integrated ribbon UI.
SelectedCellGets or sets an active cell in the active worksheet. This is a dependency property.
SelectedCommentGets or sets a comment selected in the active worksheet. This is a dependency property.
SelectedPictureGets or sets a picture selected in the active worksheet. This is a dependency property.
SelectedShapeGets or sets a shape selected in the active worksheet. This is a dependency property.
SelectionGets or sets a cell range selected in the active worksheet. This is a dependency property.
SheetCountGets the number of worksheets in the current workbook. This is a dependency property.
ShowCellToolTipModeGets or sets a condition for displaying a cell tooltip. This is a dependency property.
ShowFormulaBarGets or sets a value indicating whether the integrated formula bar should be displayed for the SpreadsheetControl. This is a dependency property.
ShowStatusBarGets or sets whether the Spreadsheet control displays the status bar. This is a dependency property.
ShowTabSelectorGets or sets whether the Sheet Tab Selector of the SpreadsheetControl should be displayed or hidden. This is a dependency property.
SnapsToDevicePixelsGets or sets a value that determines whether rendering for this element should use device-specific pixel settings during rendering. This is a dependency property. Inherited from UIElement.
StatusBarActionsProvides access to the collection of actions used to customize the Spreadsheet control’s status bar
StatusBarShowAverageSpecifies whether the status bar displays the average value of the selected cells. This is a dependency property.
StatusBarShowCountSpecifies whether the status bar displays the number of selected cells that contain data. This is a dependency property.
StatusBarShowEndModeSpecifies whether the status bar displays the End Mode label used to indicate that End Mode is activated. This is a dependency property.
StatusBarShowMaxSpecifies whether the status bar displays the maximum value of the selected cells. This is a dependency property.
StatusBarShowMinSpecifies whether the status bar displays the minimum value of the selected cells. This is a dependency property.
StatusBarShowNumericalCountSpecifies whether the status bar displays the number of selected cells that contain numerical data. This is a dependency property.
StatusBarShowPopupMenuSpecifies whether the status bar displays the context menu that allows users to show or hide status bar entries. This is a dependency property.
StatusBarShowProgressSpecifies whether the status bar displays the progress bar that indicates the progress of lengthy operations (file load/save operations and export to PDF/HTML). This is a dependency property.
StatusBarShowSumSpecifies whether the status bar displays the sum of numerical values in the selected cells. This is a dependency property.
StatusBarShowZoomSpecifies whether the status bar displays the current zoom percentage. This is a dependency property.
StatusBarShowZoomSliderSpecifies whether the status bar displays the zoom slider that allows users to zoom the worksheet. This is a dependency property.
StyleGets or sets the style used by this element when it is rendered. Inherited from FrameworkElement.
StylusPlugIns protectedGets a collection of all stylus plug-in (customization) objects associated with this element. Inherited from UIElement.
TabIndexGets or sets a value that determines the order in which elements receive focus when the user navigates through controls by using the TAB key. Inherited from Control.
TableStyleGalleryGroupsGets or sets the Table Styles gallery groups in the Ribbon UI. For internal use. This is a dependency property.
TableStylePopupGalleryGroupsGets or sets the Table Styles dropdown gallery groups in the Ribbon UI. For internal use. This is a dependency property.
TagGets or sets an arbitrary object value that can be used to store custom information about this element. Inherited from FrameworkElement.
TemplateGets or sets a control template. Inherited from Control.
TemplatedParentGets a reference to the template parent of this element. This property is not relevant if the element was not created through a template. Inherited from FrameworkElement.
ToolTipGets or sets the tool-tip object that is displayed for this element in the user interface (UI). Inherited from FrameworkElement.
TouchesCapturedGets all touch devices that are captured to this element. Inherited from UIElement.
TouchesCapturedWithinGets all touch devices that are captured to this element or any child elements in its visual tree. Inherited from UIElement.
TouchesDirectlyOverGets all touch devices that are over this element. Inherited from UIElement.
TouchesOverGets all touch devices that are over this element or any child elements in its visual tree. Inherited from UIElement.
TriggersGets the collection of triggers established directly on this element, or in child elements. Inherited from FrameworkElement.
UidGets or sets the unique identifier (for localization) for this element. This is a dependency property. Inherited from UIElement.
UnitGets or sets a unit of measure used within the control. This is a dependency property.
UseLayoutRoundingGets or sets a value that indicates whether layout rounding should be applied to this element’s size and position during layout. Inherited from FrameworkElement.
VerticalAlignmentGets or sets the vertical alignment characteristics applied to this element when it is composed within a parent element such as a panel or items control. Inherited from FrameworkElement.
VerticalContentAlignmentGets or sets the vertical alignment of the control’s content. Inherited from Control.
VerticalScrollBarProvides access to a vertical scroll bar of the SpreadsheetControl. This is a dependency property.
VerticalScrollbarVisibilityGets or sets a value that indicates whether the SpreadsheetControl’s scrollbar should be displayed or hidden.This is a dependency property.
ViewBoundsGets the bounds of the control’s viewport.
VisibilityGets or sets the user interface (UI) visibility of this element. This is a dependency property. Inherited from UIElement.
VisibleRangeGets the cell range that is currently visible in the Spreadsheet control.
VisibleSheetNamesGets the names of the visible (not hidden) worksheets in the workbook. This is a dependency property.
VisibleUnfrozenRangeGets the visible cell range of the scrollable area when there are frozen rows and columns in the worksheet.
VisualBitmapEffect protectedGets or sets the BitmapEffect value for the Visual. Inherited from Visual.
VisualBitmapEffectInput protectedGets or sets the BitmapEffectInput value for the Visual. Inherited from Visual.
VisualBitmapScalingMode protectedGets or sets the BitmapScalingMode for the Visual. Inherited from Visual.
VisualCacheMode protectedGets or sets a cached representation of the Visual. Inherited from Visual.
VisualChildrenCount protectedGets the number of visual child elements within this element. Inherited from FrameworkElement.
VisualClearTypeHint protectedGets or sets the ClearTypeHint that determines how ClearType is rendered in the Visual. Inherited from Visual.
VisualClip protectedGets or sets the clip region of the Visual as a Geometry value. Inherited from Visual.
VisualEdgeMode protectedGets or sets the edge mode of the Visual as an EdgeMode value. Inherited from Visual.
VisualEffect protectedGets or sets the bitmap effect to apply to the Visual. Inherited from Visual.
VisualOffset protectedGets or sets the offset value of the visual object. Inherited from Visual.
VisualOpacity protectedGets or sets the opacity of the Visual. Inherited from Visual.
VisualOpacityMask protectedGets or sets the Brush value that represents the opacity mask of the Visual. Inherited from Visual.
VisualParent protectedGets the visual tree parent of the visual object. Inherited from Visual.
VisualScrollableAreaClip protectedGets or sets a clipped scrollable area for the Visual. Inherited from Visual.
VisualTextHintingMode protectedGets or sets the TextHintingMode of the Visual. Inherited from Visual.
VisualTextRenderingMode protectedGets or sets the TextRenderingMode of the Visual. Inherited from Visual.
VisualTransform protectedGets or sets the Transform value for the Visual. Inherited from Visual.
VisualXSnappingGuidelines protectedGets or sets the x-coordinate (vertical) guideline collection. Inherited from Visual.
VisualYSnappingGuidelines protectedGets or sets the y-coordinate (horizontal) guideline collection. Inherited from Visual.
WidthGets or sets the width of the element. Inherited from FrameworkElement.
WorksheetDisplayAreaProvides access to an object that allows setting the maximum number of rows and columns that can be displayed in the SpreadsheetControl.

See Also

SpreadsheetControl Class

SpreadsheetControl Members

DevExpress.Xpf.Spreadsheet Namespace