diff --git a/docs/Advanced DataGrid.md b/docs/Advanced DataGrid.md new file mode 100644 index 00000000..e810a9f8 --- /dev/null +++ b/docs/Advanced DataGrid.md @@ -0,0 +1,139 @@ +# Advanced DataGrid + +The normal datagrid included in both the Community and Plus Edition of Extended WPF Toolkit is a rock-solid, high performance product with zero-lag data virtualization, the ability to handle large datasets, and with many core features. Xceed offers an advanced version of this datagrid with certain added features. You can purchase it separately, or try it for 45 days by clicking the 'Try it now' button [here](https://xceed.com/xceed-datagrid-for-wpf/), but it is also included in the [Xceed Business Suite for WPF](https://xceed.com/xceed-business-suite-for-wpf/) as well. + +The advanced version of the DataGrid includes the following additional features: + +* [Master / Detail View](#masterdetailview) +* [Tree Grid View](#treegridview) +* [Card View](#cardview) +* [3D View](#3dview) +* [Filter Row](#filterrow) +* [Insertion Row](#insertionrow) +* [Auto-filter Popup](#autofilterpopup) +* [Statistics Rows and Summary Rows](#statrows) +* [Print / Preview](#printpreview) +* [Exporting (CSV, Excel, etc.)](#exporting) +* [Column Chooser](#columnchooser) +* [Column Splitter Control](#columnsplittercontrol) +* [Persist User Settings](#persistusersettings) +* [Merged Column Headers](#mergedcolumnheaders) + dialog box for end-user to manage them +* [Design-time Support](#designtimesupport) +* [Excel-like Drag-to-Select Rows and Cells](#exceldragtoselect) +* [Asynchronous Binding Mode](#asyncbindingmode) +* [Flexible Row](#flexiblerow) +{anchor:masterdetailview} +## Master / Detail View + +When a grid is in a table-view layout, its data items can display detail data that is usually provided by the detail descriptions defined in the DataGridCollectionView or DataGridCollectionViewSource to which the grid is bound. By default, detail descriptions are automatically created for most detail relation types; however, they can also be explicitly defined. + +![](Advanced DataGrid_masterdetail.jpg) +{anchor:treegridview} +## Tree Grid View + +Represents a table-view layout similar to TableflowView, in which rows are laid out horizontally as in traditional grid-like styles, but detail columns are aligned with the columns of the master, and one column displays data using a tree-structure. + +Like TableflowView, it provides animated smooth scrolling, sticky group headers and sticky master-detail master row and headers, full-column animated drag and drop reordering. + +![](Advanced DataGrid_treegridview.png) +{anchor:cardview} +## Card View + +The CardView and CompactCardView classes provide card-view layouts for the data items in a grid. Either layout can be used to display data items as cards; however, the compact card-view layout applies well when a database has many columns but few of the fields contain data. In this case, the fields that do not contain data will not be displayed in the cards, giving them a more compact appearance. + +![](Advanced DataGrid_cardview.png) +{anchor:3dview} +## 3D View + +The Cardflow™ 3D view, which is represented by the CardflowView3D class, provides a 3-dimensional card-view layout for the data items in a grid and allows various card "surfaces" to display data using customized, theme-defined surface configurations. + +![](Advanced DataGrid_cardflowview3D.png) +{anchor:filterrow} +## Filter Row + +The FilterRow class represents a row in which values can be entered to filter the items in the corresponding columns. Custom type columns can also be filtered if they provide a TypeConverter (from string) and implement IComparable. + +![](Advanced DataGrid_filterrow.png) +{anchor:insertionrow} +## Insertion Row + +The InsertionRow class represents a row in which values can be entered to insert a new item to the grid. + +![](Advanced DataGrid_insertionrow.png) +{anchor:autofilterpopup} +## Auto-filter Popup + +In addition to the native CollectionView filtering, the DataGridCollectionView and DataGridDetailDescription classes also support automatic filtering, which provides Excel-like end-user filtering according to the distinct values of each column. Automatic filtering can be enabled by setting the AutoFilterMode property to And or Or (by default, None), indicating whether data items will be filtered according to all or at least one of the filtering criteria defined by each column's auto-filter control. The DistinctValuesConstraint property can also be set to determine if the distinct values are to be filtered according to the result of previous auto-filtering operations. + +![](Advanced DataGrid_autofilterpopup.png) +{anchor:statrows} +## Statistics Rows and Summary Rows + +The StatRow class represents a row that can be used to display statistical results. + +![](Advanced DataGrid_statrows.png) +{anchor:printpreview} +## Print / Preview + +The appearance of a grid when it is printed or exported is determined by the view assigned to a grid's PrintView property and the theme assigned to the view's Theme property. When a grid is printed using the default view and theme, the resulting pages will not have headers or footers and only a column-manager row will be contained in a grid's fixed-header section regardless of the configuration of the runtime grid. + +The ShowPrintPreviewWindow and ShowPrintPreviewPopup methods provide print preview capabilities. ShowPrintPreviewPopup should be used when the application is being deployed as an XBAP, as XBAP applications cannot open new windows. +{anchor:exporting} +## Exporting (CSV, Excel, etc.) + +Xceed DataGrid for WPF supports exporting to the XML spreadsheet format (xmlss). These files can be loaded in Excel 2002 and up as well as through the Microsoft Office XP Web Components Spreadsheet Component. The DataGrid also supports exporting to the CSV format, which is compatible with a wide variety of applications. + +The DataGridControl class also exposes the ExportToXps method, which allows a grid to be exported as an XPS document. +{anchor:columnchooser} +## Column Chooser + +The columns that are displayed in a grid can be chosen by the user through the column-chooser context menu, which can be enabled by setting the AllowColumnChooser defined on the view to true. A column's ShowInColumnChooser property determines whether a column's title is displayed in the menu, allowing its visibility to be manipulated by an end user. By default, the column-chooser context menu displays the titles of the columns in the same order as the they are positioned; however, through the ColumnChooserSortOrder property, the order can be changed to sort the titles alphabetically. + +![](Advanced DataGrid_columnchooser.png) + +Instead of the default context menu style (shown above), the built-in dialog control can be used for a different look/behavior (shown below). A third option is to provide a custom look to the context menu. + +![](Advanced DataGrid_columnchooserdialog.png) +{anchor:columnsplittercontrol} +## Column Splitter Control + +When a grid is in a table-view layout, the first n columns can be fixed so that they do not scroll with the grid content. Fixed columns are separated from their scrollable counterparts by a fixed-column splitter, which can be dragged to add or remove fixed columns. Likewise, column-manager cells can be dragged to the left or right of the fixed-column splitter to add or remove fixed columns. The appearance of the fixed-column splitter can be defined for each row type. + +![](Advanced DataGrid_fixedcolumnsplitter.jpg) +{anchor:persistusersettings} +## Persist User Settings + +The settings of a grid and its elements can be persisted and re-applied using the SaveUserSettings and LoadUserSettings methods, respectively. By default, column widths, visibilities, positions, and fixed-column counts as well as grouping and sorting criteria are persisted; merged columns, their positions, and their visibilities can also be persisted. However, these settings can be modified when calling the SaveUserSettings and LoadUserSettings methods. + +![](Advanced DataGrid_persistusersettings.png) +{anchor:mergedcolumnheaders} +## Merged Column Headers + +Merged column headers can be used to present data more clearly and logically. They are displayed in the FixedHeaders section of a grid. Columns can be grouped ("merged") under these merged headers, as can other groups of columns. Merged headers and their columns can be moved (drag-and-drop, programmatically) and removed / added back. + +![](Advanced DataGrid_mergedcolumnheaders.png) +{anchor:designtimesupport} +## Design-time Support + +Xceed DataGrid for WPF provides design-time support for Visual Studio and Expression Blend. In Visual Studio, the DataGridControl control will appear in the toolbox under the Xceed tab and can be added to the design surface by double-clicking on the control or through drag and drop. It's properties can then be modified through the Visual Studio property grid or by using the Xceed DataGrid for WPF Configuration Window. + +![](Advanced DataGrid_designtimesupport.png) +{anchor:exceldragtoselect} +## Excel-like Drag-to-Select Rows and Cells + +The datagrid allows users to select multiple items or cells using Left-Click and then dragging the mouse within the datagrid. This allows range selection to be performed without having to hold the Shift key on the keyboard. + +To activate this feature, set the DataGrid's AllowDrag property to true, and the DragBehavior property to "Select". The View must be a valid instance or subclass of TableView (ex. TableFlowView, TreeGridflowView). +{anchor:asyncbindingmode} +## Asynchronous Binding Mode + +The IsAsync property can be used when the get accessor of your binding source property might take a long time. One example is an image property with a get accessor that downloads from the Web. Setting IsAsync to true avoids blocking the UI while the download occurs. + +While waiting for the value to arrive, the binding reports the value set on the FallbackValue property, if one is available, or the default value of the binding target property. +{anchor:flexiblerow} +## Flexible Row + +The FlexibleRow class represents a row that can be put inside any header or footer, and can display content that is not bound or related to the grid's data source. + +![](Advanced DataGrid_flexiblerow.png) +--- \ No newline at end of file diff --git a/docs/Advanced DataGrid_autofilterpopup.png b/docs/Advanced DataGrid_autofilterpopup.png new file mode 100644 index 00000000..4b12a9d8 Binary files /dev/null and b/docs/Advanced DataGrid_autofilterpopup.png differ diff --git a/docs/Advanced DataGrid_cardflowview3D.png b/docs/Advanced DataGrid_cardflowview3D.png new file mode 100644 index 00000000..d66bb9b2 Binary files /dev/null and b/docs/Advanced DataGrid_cardflowview3D.png differ diff --git a/docs/Advanced DataGrid_cardview.png b/docs/Advanced DataGrid_cardview.png new file mode 100644 index 00000000..ad87e588 Binary files /dev/null and b/docs/Advanced DataGrid_cardview.png differ diff --git a/docs/Advanced DataGrid_columnchooser.png b/docs/Advanced DataGrid_columnchooser.png new file mode 100644 index 00000000..3c51010c Binary files /dev/null and b/docs/Advanced DataGrid_columnchooser.png differ diff --git a/docs/Advanced DataGrid_columnchooserdialog.png b/docs/Advanced DataGrid_columnchooserdialog.png new file mode 100644 index 00000000..6a4c810b Binary files /dev/null and b/docs/Advanced DataGrid_columnchooserdialog.png differ diff --git a/docs/Advanced DataGrid_designtimesupport.png b/docs/Advanced DataGrid_designtimesupport.png new file mode 100644 index 00000000..624832a9 Binary files /dev/null and b/docs/Advanced DataGrid_designtimesupport.png differ diff --git a/docs/Advanced DataGrid_filterrow.png b/docs/Advanced DataGrid_filterrow.png new file mode 100644 index 00000000..c37100db Binary files /dev/null and b/docs/Advanced DataGrid_filterrow.png differ diff --git a/docs/Advanced DataGrid_fixedcolumnsplitter.jpg b/docs/Advanced DataGrid_fixedcolumnsplitter.jpg new file mode 100644 index 00000000..b37a424b Binary files /dev/null and b/docs/Advanced DataGrid_fixedcolumnsplitter.jpg differ diff --git a/docs/Advanced DataGrid_flexiblerow.png b/docs/Advanced DataGrid_flexiblerow.png new file mode 100644 index 00000000..66bab09d Binary files /dev/null and b/docs/Advanced DataGrid_flexiblerow.png differ diff --git a/docs/Advanced DataGrid_insertionrow.png b/docs/Advanced DataGrid_insertionrow.png new file mode 100644 index 00000000..a260e956 Binary files /dev/null and b/docs/Advanced DataGrid_insertionrow.png differ diff --git a/docs/Advanced DataGrid_masterdetail.jpg b/docs/Advanced DataGrid_masterdetail.jpg new file mode 100644 index 00000000..af2193be Binary files /dev/null and b/docs/Advanced DataGrid_masterdetail.jpg differ diff --git a/docs/Advanced DataGrid_mergedcolumnheaders.png b/docs/Advanced DataGrid_mergedcolumnheaders.png new file mode 100644 index 00000000..f38665dd Binary files /dev/null and b/docs/Advanced DataGrid_mergedcolumnheaders.png differ diff --git a/docs/Advanced DataGrid_persistusersettings.png b/docs/Advanced DataGrid_persistusersettings.png new file mode 100644 index 00000000..f99dd4ac Binary files /dev/null and b/docs/Advanced DataGrid_persistusersettings.png differ diff --git a/docs/Advanced DataGrid_statrows.png b/docs/Advanced DataGrid_statrows.png new file mode 100644 index 00000000..28c3b4eb Binary files /dev/null and b/docs/Advanced DataGrid_statrows.png differ diff --git a/docs/Advanced DataGrid_treegridview.png b/docs/Advanced DataGrid_treegridview.png new file mode 100644 index 00000000..8c1deffe Binary files /dev/null and b/docs/Advanced DataGrid_treegridview.png differ diff --git a/docs/AnimatedTimelinePanel.md b/docs/AnimatedTimelinePanel.md new file mode 100644 index 00000000..cb457202 --- /dev/null +++ b/docs/AnimatedTimelinePanel.md @@ -0,0 +1,53 @@ +# AnimatedTimelinePanel +_Only available in the Plus Edition_ + +Derives from AnimationPanel + +Defines an area where items are positioned on a timeline. + +![](AnimatedTimelinePanel_animatedtimelinepanel.jpg) + +## Properties +|| Property || Description +| * | All the Properties from [Canvas](Canvas) Panel +| BeginDate | Gets or sets the date corresponding to the beginning of the TimelinePanel. +| CanHorizontallyScroll | Gets or sets if the horizontal scrolling is enabled. +| CanVerticallyScroll | Gets or sets if the vertical scrolling is enabled. +| Date (attached) | Gets or sets the Date of a children. +| DateEnd (attached) | Gets or sets the end Date of a children. +| EndDate | Gets or sets the date corresponding to the end of the AnimatedTimelinePanel. +| ExtendHeight | Gets the Height extended for the panel. +| ExtendWidth | Gets the Width extended for the panel. +| HorizontalOffset | Gets the horizontal offset for the panel. +| KeepOriginalOrderForOverlap | Gets or sets if the orginal order should be kept when overlapping occurs. +| Orientation | Gets or sets the orientation (Vertical/Horizontal) of the Panel. +| OverlapBehavior | Gets or sets the OverlapBehavior dependency property. +| ScrollOwner | Gets or sets the ScrollViewer. +| UnitSize | Gets or sets the size of one unit. +| UnitTimeSpan | Gets or sets the TimeSpan for one unit. +| VerticalOffset | Gets the Vertical offset. +| ViewportHeight | Gets the height of the viewport. +| ViewportWidth | Gets the width of the viewport. + +## Events +|| Event || Description +| * | All the Events from [Canvas](Canvas) Panel + +## Methods +|| Method || Description +| LineDown() | Sets Vertical offset down by one. +| LineLeft() | Sets Horizontal offset left by one. +| LineUp() | Sets Vertical offset up by one. +| LineRight() | Sets Horizontal offset right by one. +| MakeVisible( Visual visual, Rect rectangle ) | show a children of the panel. +| MouseWheelDown() | Sets Vertical offset down by SystemParameters.WheelScrollLines. +| MouseWheelLeft() | Sets Horizontal offset left by SystemParameters.WheelScrollLines. +| MouseWheelUp() | Sets Vertical offset up by SystemParameters.WheelScrollLines. +| MouseWheelRight() | Sets Horizontal offset right by SystemParameters.WheelScrollLines. +| PageDown() | Sets Vertical offset down by page. +| PageLeft() | Sets Horizontal offset left by page. +| PageUp() | Sets Vertical offset up by page. +| PageRight() | Sets Horizontal offset right by page. +| SetHorizontalOffset( double offset ) | Sets the Horizontal offset. +| SetVerticalOffset( double offset ) | Sets the Vertical offset. +--- \ No newline at end of file diff --git a/docs/AnimatedTimelinePanel_animatedtimelinepanel.jpg b/docs/AnimatedTimelinePanel_animatedtimelinepanel.jpg new file mode 100644 index 00000000..51348ed8 Binary files /dev/null and b/docs/AnimatedTimelinePanel_animatedtimelinepanel.jpg differ diff --git a/docs/Area.md b/docs/Area.md new file mode 100644 index 00000000..cac3f861 --- /dev/null +++ b/docs/Area.md @@ -0,0 +1,32 @@ +# Area +_Only available in the Plus Edition_ + +Derives from Panel + +Used to display charts and a grid with axes and labels. Use the [Series](Series) property to specify the list of DataPoints. + +* [Series](Series) +* [Axis](Axis) + +## Properties +|| Property || Description +| Title | Gets or sets Area title. +| XAxis | Gets or sets X axis. +| YAxis | Gets or sets Y axis. +| Series | Gets or sets list of Series. +| LayoutBounds | Gets layout bounds for series interior. +| BackgroundTemplate | Gets or sets data template for grid representation. + +## Methods +|| Method|| Description +| GetSeriesLayoutBounds() | Calculates layout bounds without tick and tittle labels. +| Invalidate() | Invalidates Area and all it's children. +| GetActualPoint( Point point ) | Converts point in user logic coordinates into actual pixels point. +| GetActualPoint( DataPoint point ) | Converts DataPoint into actual pixels point. +| HighlightSeries( Series series, bool highlighted ) | Sets highlighted state for specified series. + +## Events +|| Event || Description +| LegendRefresh | Raised when need legend items refresh. + +--- \ No newline at end of file diff --git a/docs/AutoSelectTextBox.md b/docs/AutoSelectTextBox.md new file mode 100644 index 00000000..0cff7bf5 --- /dev/null +++ b/docs/AutoSelectTextBox.md @@ -0,0 +1,119 @@ +# AutoSelectTextBox + +Derives from TextBox + +AutoSelectTextBox is a control whose content is selected when it receives the focus. It also performs automatic focus navigation when the caret reaches the extremities of the text range. + +## Usage + +**XAML** + +{{ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + AutoSelectBehavior: + + The value of the "AutoSelectBehavior" property determines whether the content of the AutoSelectTextBox will be selected or not when the control gets the focus. + + + AutoMoveFocus: + + Effect with "MaxLength" property: + + + Setting the "MaxLength" of the text box allows the focus to move from the AutoSelectTextBox once the max length has been reached. + In the following "Telephone Number" fields, the "MaxLength" properties of the controls have been set to 3, 3, and 4. + + + + + + + + + + + + + + + + + Effect with Arrow keys + + + Setting "AutoMoveFocus" to true also allows navigating the focus through the controls using the arrow keys to move the focus up, down, left, or right. + You are no longer limited to the "left-right" navigation of the "Tab, Shift-Tab" keys. + + + + + + + + + + + + + + + + + + + + + + + + + +}} +## Properties +|| Property || Description +| AutoMoveFocus | Gets or sets a value indicating if the focus can navigate in the appropriate flow direction (e.g., from one cell to another when a cell is being edited) when the cursor is at the beginning or end of the auto-select text box. +| AutoSelectBehavior | Gets or sets a value indicating how the content of the auto-select text box is selected (Never or OnFocus). By default, Never. + +**Support this project, check out the [Plus Edition](https://xceed.com/xceed-toolkit-plus-for-wpf/).** +--- \ No newline at end of file diff --git a/docs/AutoStretchStackPanel.md b/docs/AutoStretchStackPanel.md new file mode 100644 index 00000000..4ecdd993 --- /dev/null +++ b/docs/AutoStretchStackPanel.md @@ -0,0 +1,20 @@ +# AutoStretchStackPanel +_Only available in the Plus Edition_ + +Derives from AnimationPanel + +This panel stretches the children in the orientation direction so that they completely fill the panel area. + +![](AutoStretchStackPanel_autostretchstackpanel.jpg) + +## Properties +|| Property || Description +| * | All the Properties from [Canvas](Canvas) Panel +| IsChildrenreversed | Gets or sets the IsChildOrderReversed property. This dependency property indicates whether the children are laid out from left to right (or top to bottom for a vertical orientation), as a normal stack panel is, or whether the stack is inverted and laid out from right to left (or bottom to top for a vertical orientation). +| GapRatio | Gets or sets the GapRatio property. This dependency property indicates the size of the gap between items as a ratio to the item size, itself. +| Orientation | Gets or sets the Orientation property. This dependency property indicates the orientation direction in which items are arranged in the panel. + +## Events +|| Event || Description +| * | All the Events from [Canvas](Canvas) Panel. +--- \ No newline at end of file diff --git a/docs/AutoStretchStackPanel_autostretchstackpanel.jpg b/docs/AutoStretchStackPanel_autostretchstackpanel.jpg new file mode 100644 index 00000000..9ff4059b Binary files /dev/null and b/docs/AutoStretchStackPanel_autostretchstackpanel.jpg differ diff --git a/docs/AvalonDock.md b/docs/AvalonDock.md new file mode 100644 index 00000000..a79a8bf3 --- /dev/null +++ b/docs/AvalonDock.md @@ -0,0 +1,169 @@ +# AvalonDock (docking window control) + +AvalonDock provides a system that allow developers to create customizable layouts using a window docking system similar to what is found in many popular integrated development environments (IDEs). + +AvalonDock adheres to an MVVM design. The Model is represented by the classes contained in the Xceed.Wpf.AvalonDock.Layout namespace. The classes in this namespace are the layout elements in a layout model (for example LayoutAnchorable/LayoutDocument, LayoutAnchorablePane/LayoutDocumentPane, LayoutAnchorablePaneGroup/LayoutDocumentPaneGroup, etc.) that are used directly in XAML within a DockingManager to describe how the layout is composed. + +* [DockingManager class](#dockingmanager_class) +* [Layout model classes](#layout_model_classes) + +![](AvalonDock_avalondock.jpg) + +The following example shows how to set up various layout elements in a DockingManager. + +{{ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +