DocumentPreviewControl Properties
A control that you can use to publish (preview, print, and export) documents in WPF applications.Name | Description |
---|---|
ActualBarsTemplate | Specifies a data template used to display an actual Bars toolbar of a document viewer. This is a dependency property. Inherited from DocumentViewerControl. |
ActualBehaviorProvider | Specifies an actual behavior provider of the document viewer. This is a dependency property. Inherited from DocumentViewerControl. |
ActualCommandProvider | Gets an actual command provider of the document preview. |
ActualDocumentMapSettings | Provides access to the actual settings of the document map, which reflects the document structure in a tree-like form. Inherited from DocumentViewerControl. |
ActualHeight | Gets the rendered height of this element. Inherited from FrameworkElement. |
ActualNavigationPaneSettings | Provides access to the actual Navigation Pane settings. This is a dependency property. |
ActualWidth | Gets the rendered width of this element. Inherited from FrameworkElement. |
AllowCachePages | Specifies whether to cache page textures, which improves the rendering performance when viewing large documents. This is a dependency property. |
AllowDocumentEditing | Specifies whether editing a document’s content is enabled. |
AllowDrop | Gets 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. |
AreAnyTouchesCaptured | Gets a value that indicates whether at least one touch is captured to this element. Inherited from UIElement. |
AreAnyTouchesCapturedWithin | Gets 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. |
AreAnyTouchesDirectlyOver | Gets a value that indicates whether at least one touch is pressed over this element. Inherited from UIElement. |
AreAnyTouchesOver | Gets 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. |
AutoShowDocumentMap | Specifies whether the Document Map panel is automatically shown if a displayed document contains bookmarks. This is a dependency property. |
AutoShowParametersPanel | Specifies whether the Parameters panel is automatically shown if a displayed report contains report parameters. This is a dependency property. |
Background | Gets or sets a brush that describes the background of a control. Inherited from Control. |
BarsTemplate | Specifies a data template used to display a Bars toolbar of a document viewer. This is a dependency property. Inherited from DocumentViewerControl. |
BehaviorProvider | Specifies a document viewer’s behavior provider. This is a dependency property. Inherited from DocumentViewerControl. |
BindingGroup | Gets or sets the BindingGroup that is used for the element. Inherited from FrameworkElement. |
BitmapEffect | Gets or sets a bitmap effect that applies directly to the rendered content for this element. This is a dependency property. Inherited from UIElement. |
BitmapEffectInput | Gets 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. |
BorderBrush | Gets or sets a brush that describes the border background of a control. Inherited from Control. |
BorderThickness | Gets or sets the border thickness of a control. Inherited from Control. |
CacheMode | Gets or sets a cached representation of the UIElement. Inherited from UIElement. |
CanSelectPageByClick | Allows you not to scroll to the top of the page when you click an unselected page. |
Clip | Gets or sets the geometry used to define the outline of the contents of an element. This is a dependency property. Inherited from UIElement. |
ClipToBounds | Gets 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. |
ClockwiseRotateCommand | Returns a command that rotates pages of a displayed document by 90 degrees clockwise. Inherited from DocumentViewerControl. |
CloseDocumentCommand | Returns a command that closes the currently opened document. Inherited from DocumentViewerControl. |
ColumnsCount | Gets or sets the number of columns used to display document pages in the DocumentPreviewControl. This is a dependency property. |
CommandBarStyle | Specifies the type of a Document Viewer toolbar. This is a dependency property. Inherited from DocumentViewerControl. |
CommandBindings | Gets 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. |
CommandProvider | Specifies a Document Viewer’s command provider. This is a dependency property. Inherited from DocumentViewerControl. |
ContextMenu | Gets 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. |
CopyCommand | Returns a command that copies selected contents of the displayed document to the clipboard. |
CounterClockwiseRotateCommand | Returns a command that rotates pages of a displayed document by 90 degrees counterclockwise. Inherited from DocumentViewerControl. |
CurrentPageNumber | Specifies the number of the currently displayed page. This is a dependency property. Inherited from DocumentViewerControl. |
Cursor | Gets or sets the cursor that displays when the mouse pointer is over this element. Inherited from FrameworkElement. |
CursorMode | Gets or sets the cursor type. This is a dependency property. |
DataContext | Gets or sets the data context for an element when it participates in data binding. Inherited from FrameworkElement. |
DefaultStyleKey protected | Gets or sets the key to use to reference the style for this control, when theme styles are used or defined. Inherited from FrameworkElement. |
DependencyObjectType | Gets the DependencyObjectType that wraps the CLR type of this instance. Inherited from DependencyObject. |
DesiredSize | Gets the size that this element computed during the measure pass of the layout process. Inherited from UIElement. |
DialogServiceTemplate | Specifies a data template which provides a service to display dialog windows in the document preview. This is a dependency property. |
Dispatcher | Gets the Dispatcher this DispatcherObject is associated with. Inherited from DispatcherObject. |
DisposeDocumentOnUnload | Inherited from DocumentViewerControl. |
Document | Provides access to the current document’s view model settings. |
DocumentMapSettings | |
DocumentSource | Specifies the document source. This is a dependency property. Inherited from DocumentViewerControl. |
EditingFieldTemplateSelector | Specifies an object that chooses a template for in-place editors used to customize editing fields. This is a dependency property. |
Effect | Gets or sets the bitmap effect to apply to the UIElement. This is a dependency property. Inherited from UIElement. |
EnableContinuousScrolling | Specifies whether to jump to the beginning of the next page on reaching the end of the previous page, or enable smooth (continuous) vertical scrolling. This is a dependency property. |
ExportCommand | Returns a command that invokes the Export Document dialog to export the currently displayed document to one of the supported third-party formats. |
FindTextCommand | Returns a command that searches for text within a displayed document. Inherited from DocumentViewerControl. |
FirstPageCommand | Returns a command that navigates to the first page of a displayed document. |
FlowDirection | Gets or sets the direction that text and other user interface (UI) elements flow within any parent element that controls their layout. Inherited from FrameworkElement. |
Focusable | Gets or sets a value that indicates whether the element can receive focus. This is a dependency property. Inherited from UIElement. |
FocusVisualStyle | Gets 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. |
FontFamily | Gets or sets the font family of the control. Inherited from Control. |
FontSize | Gets or sets the font size. Inherited from Control. |
FontStretch | Gets or sets the degree to which a font is condensed or expanded on the screen. Inherited from Control. |
FontStyle | Gets or sets the font style. Inherited from Control. |
FontWeight | Gets or sets the weight or thickness of the specified font. Inherited from Control. |
ForceCursor | Gets 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. |
Foreground | Gets or sets a brush that describes the foreground color. Inherited from Control. |
HandlesScrolling protected | Gets a value that indicates whether a control supports scrolling. Inherited from Control. |
HasAnimatedProperties | Gets a value indicating whether this element has any animated properties. Inherited from UIElement. |
HasEffectiveKeyboardFocus protected | Gets a value that indicates whether the UIElement has focus. Inherited from UIElement. |
HasSelection | Gets whether there is any selected content in the current document. This is a dependency property. |
Height | Gets or sets the suggested height of the element. Inherited from FrameworkElement. |
HiddenExportFormats | Provides access to the collection of export formats that cannot be used to export the document. This is a dependency property. |
HighlightCurrentPage | Specifies whether to display an additional border around the currently selected document page in a Document Preview. This is a dependency property. |
HighlightEditingFields | Specifies whether editing fields are automatically highlighted. This is a dependency property. |
HighlightSelectionColor | Gets or sets the color used to highlight the document preview’s selected content. This is a dependency property. |
HorizontalAlignment | Gets 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. |
HorizontalContentAlignment | Gets or sets the horizontal alignment of the control’s content. Inherited from Control. |
HorizontalPageSpacing | Gets or sets the horizontal spacing between document pages in multi-column layout. Inherited from DocumentViewerControl. |
InheritanceBehavior protected | Gets or sets the scope limits for property value inheritance, resource key lookup, and RelativeSource FindAncestor lookup. Inherited from FrameworkElement. |
InputBindings | Gets the collection of input bindings associated with this element. Inherited from UIElement. |
InputScope | Gets or sets the context for input used by this FrameworkElement. Inherited from FrameworkElement. |
IsArrangeValid | Gets a value indicating whether the computed size and position of child elements in this element’s layout are valid. Inherited from UIElement. |
IsEnabled | Gets or sets a value indicating whether this element is enabled in the user interface (UI). This is a dependency property. Inherited from UIElement. |
IsEnabledCore protected | Gets a value that becomes the return value of IsEnabled in derived classes. Inherited from UIElement. |
IsFocused | Gets a value that determines whether this element has logical focus. This is a dependency property. Inherited from UIElement. |
IsHitTestVisible | Gets 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. |
IsInitialized | Gets 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. |
IsInputMethodEnabled | Gets 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. |
IsKeyboardFocused | Gets a value indicating whether this element has keyboard focus. This is a dependency property. Inherited from UIElement. |
IsKeyboardFocusWithin | Gets 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. |
IsLoaded | Gets a value that indicates whether this element has been loaded for presentation. Inherited from FrameworkElement. |
IsManipulationEnabled | Gets or sets a value that indicates whether manipulation events are enabled on this UIElement. Inherited from UIElement. |
IsMeasureValid | Gets a value indicating whether the current size returned by layout measure is valid. Inherited from UIElement. |
IsMouseCaptured | Gets a value indicating whether the mouse is captured to this element. This is a dependency property. Inherited from UIElement. |
IsMouseCaptureWithin | Gets 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. |
IsMouseDirectlyOver | Gets 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. |
IsMouseOver | Gets 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. |
IsSealed | Gets a value that indicates whether this instance is currently sealed (read-only). Inherited from DependencyObject. |
IsSearchControlVisible | Indicates whether a document viewer’s Search panel is currently visible. This is a dependency property. Inherited from DocumentViewerControl. |
IsStylusCaptured | Gets a value indicating whether the stylus is captured by this element. This is a dependency property. Inherited from UIElement. |
IsStylusCaptureWithin | Gets 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. |
IsStylusDirectlyOver | Gets 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. |
IsStylusOver | Gets a value indicating whether the stylus cursor is located over this element (including visual child elements). This is a dependency property. Inherited from UIElement. |
IsTabStop | Gets or sets a value that indicates whether a control is included in tab navigation. Inherited from Control. |
IsVisible | Gets a value indicating whether this element is visible in the user interface (UI). This is a dependency property. Inherited from UIElement. |
Language | Gets or sets localization/globalization language information that applies to an element. Inherited from FrameworkElement. |
LastPageCommand | Returns a command that navigates to the last page of a displayed document. |
LayoutTransform | Gets or sets a graphics transformation that should apply to this element when layout is performed. Inherited from FrameworkElement. |
LogicalChildren protected | Gets an enumerator for logical child elements of this element. Inherited from FrameworkElement. |
Margin | Gets or sets the outer margin of an element. Inherited from FrameworkElement. |
MaxHeight | Gets or sets the maximum height constraint of the element. Inherited from FrameworkElement. |
MaxWidth | Gets or sets the maximum width constraint of the element. Inherited from FrameworkElement. |
MessageBoxServiceTemplate | Specifies a data template which provides a service to display message boxes in the document preview. This is a dependency property. |
MinHeight | Gets or sets the minimum height constraint of the element. Inherited from FrameworkElement. |
MinWidth | Gets or sets the minimum width constraint of the element. Inherited from FrameworkElement. |
Name | Gets 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. |
NavigateCommand | Returns a command that navigates to a specified target location within a displayed document. Inherited from DocumentViewerControl. |
NavigationPaneSettings | Specifies Navigation Pane settings. This is a dependency property. |
NextPageCommand | Returns a command that navigates to the next page of a displayed document. Inherited from DocumentViewerControl. |
NextViewCommand | Returns a command that navigates to the next view in a displayed document. Inherited from DocumentViewerControl. |
Opacity | Gets 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. |
OpacityMask | Gets 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. |
OpenDocumentCommand | Returns a command that opens a document from a specified file in the viewer. Inherited from DocumentViewerControl. |
OpenFileDialogTemplate | Specifies a data template used to display the Open dialog. This is a dependency property. Inherited from DocumentViewerControl. |
OverridesDefaultStyle | Gets or sets a value that indicates whether this element incorporates style properties from theme styles. Inherited from FrameworkElement. |
Padding | Gets or sets the padding inside a control. Inherited from Control. |
PageCount | Gets the total number of pages within a displayed document. Inherited from DocumentViewerControl. |
PageDisplayMode | Gets or sets the page display mode in the document preview. This is a dependency property. |
PageRotation | Specifies the rotation of the displayed document’s pages. This is a dependency property. Inherited from DocumentViewerControl. |
PageSetupCommand | Returns a command that invokes the Page Setup dialog. |
ParameterPanelViewModel | |
ParametersModel | Obsolete. Provides access to a collection of ParameterModel objects associated with the DocumentPreviewControl class. This is a dependency property. |
Parent | Gets the logical parent element of this element. Inherited from FrameworkElement. |
PersistId | Gets a value that uniquely identifies this element. Inherited from UIElement. |
PresenterTemplate | For internal use. Inherited from DocumentViewerControl. |
PreviousPageCommand | Returns a command that navigates to the previous page of a displayed document. Inherited from DocumentViewerControl. |
PreviousViewCommand | Returns a command that navigates to the previous view in a displayed document. Inherited from DocumentViewerControl. |
PrintCommand | Returns a command that invokes the Print dialog to print the currently displayed document. |
PrintDirectCommand | Returns a command that prints the currently displayed document without invoking the Print dialog. |
PropertyProvider | Specifies a document preview’s property provider. This is a dependency property. |
RenderSize | Gets (or sets) the final render size of this element. Inherited from UIElement. |
RenderTransform | Gets or sets transform information that affects the rendering position of this element. This is a dependency property. Inherited from UIElement. |
RenderTransformOrigin | Gets 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. |
RequestDocumentCreation | Specifies whether to create a document automatically, or on a user request. This is a dependency property. |
ResetSettingsOnDocumentClose | Specifies whether to reset document display settings after the current document is closed. This is a dependency property. Inherited from DocumentViewerControl. |
Resources | Gets or sets the locally-defined resource dictionary. Inherited from FrameworkElement. |
RibbonTemplate | Specifies a data template used to display a Ribbon toolbar of a document viewer. This is a dependency property. Inherited from DocumentViewerControl. |
SaveCommand | Returns a command that invokes the Save As dialog to save the currently displayed document. |
SaveFileDialogTemplate | Gets or sets a data template used to display the Save As dialog. This is a dependency property. |
ScaleCommand | Returns a command that invokes the Scale dialog. |
ScrollCommand | Returns a command that scrolls a displayed document. Inherited from DocumentViewerControl. |
SendCommand | Returns a command that invokes the Export Document dialog to export the currently displayed document to one of the supported third-party formats and attaches the resulting file to a new empty message in the default mail program. |
SetCursorModeCommand | Returns a command that sets the cursor mode for the document preview. |
SetPageLayoutCommand | Defines the page layout settings in a Document Preview. |
SetPageNumberCommand | Returns a command that sets the number of a currently displayed page. Inherited from DocumentViewerControl. |
SetWatermarkCommand | Returns a command that invokes the Watermark dialog. |
SetZoomFactorCommand | Returns a command that changes a zoom factor of a displayed document to a specified value. Inherited from DocumentViewerControl. |
SetZoomModeCommand | Returns a command that changes the current document zoom mode. Inherited from DocumentViewerControl. |
ShowCoverPage | Specifies whether to display the first document page separately or alongside the next document page in the Two Pages view. This is a dependency property. |
ShowFindTextCommand | Returns a command that shows the Search panel. Inherited from DocumentViewerControl. |
ShowNavigationPane | Specifies whether to show the Navigation Pane in the Document Preview. This is a dependency property. |
ShowPageMargins | Specifies whether a to display the lines indicating a document’s margins in Print Preview. This is a dependency property. |
ShowThumbnails | Specifies whether report thumbnails are automatically shown. This is a dependency property. |
SnapsToDevicePixels | Gets 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. |
StopPageBuildingCommand | Returns a command that stops generating document pages. |
Style | Gets or sets the style used by this element when it is rendered. Inherited from FrameworkElement. |
StylusPlugIns protected | Gets a collection of all stylus plug-in (customization) objects associated with this element. Inherited from UIElement. |
TabIndex | Gets 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. |
Tag | Gets or sets an arbitrary object value that can be used to store custom information about this element. Inherited from FrameworkElement. |
Template | Gets or sets a control template. Inherited from Control. |
TemplatedParent | Gets 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. |
ThumbnailsSettings | Provides access to actual settings of report thumbnails. This is a dependency property. |
ToggleDocumentMapCommand | Returns a command that toggles the visibility of the Document Map, which reflects the current document’s structure in a tree-like form. |
ToggleEditingFieldsCommand | Returns a command that toggles highlighting of all available fields whose content can be edited. |
ToggleEnableContinuousScrollingCommand | Returns a command that toggles the continuous scrolling mode in a Document Viewer. |
ToggleNavigationPaneCommand | Returns a command that toggles the visibility of the Document Preview‘s Navigation Pane. |
ToggleParametersPanelCommand | Returns a command that toggles the visibility of the Parameters panel. |
ToggleShowCoverPageCommand | Returns a command that controls the display mode of the first document page in a Document Preview. |
ToggleThumbnailsCommand | Returns a command that toggles the visibility of thumbnails. |
ToolTip | Gets or sets the tool-tip object that is displayed for this element in the user interface (UI). Inherited from FrameworkElement. |
TouchesCaptured | Gets all touch devices that are captured to this element. Inherited from UIElement. |
TouchesCapturedWithin | Gets all touch devices that are captured to this element or any child elements in its visual tree. Inherited from UIElement. |
TouchesDirectlyOver | Gets all touch devices that are over this element. Inherited from UIElement. |
TouchesOver | Gets all touch devices that are over this element or any child elements in its visual tree. Inherited from UIElement. |
Triggers | Gets the collection of triggers established directly on this element, or in child elements. Inherited from FrameworkElement. |
Uid | Gets or sets the unique identifier (for localization) for this element. This is a dependency property. Inherited from UIElement. |
UndoRedoManager | Provides access to an object that manages the undo and redo operations in the document viewer. This is a dependency property. Inherited from DocumentViewerControl. |
UseAsyncDocumentCreation | Gets or sets whether the DocumentPreviewControl should create a report document asynchronously in a separate task. |
UseLayoutRounding | Gets or sets a value that indicates whether layout rounding should be applied to this element’s size and position during layout. Inherited from FrameworkElement. |
UseOfficeInspiredNavigationPane | Specifies whether the Document Preview uses an MS Office-inspired Navigation Pane. This is a dependency property. |
VerticalAlignment | Gets 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. |
VerticalContentAlignment | Gets or sets the vertical alignment of the control’s content. Inherited from Control. |
Visibility | Gets or sets the user interface (UI) visibility of this element. This is a dependency property. Inherited from UIElement. |
VisualBitmapEffect protected | Gets or sets the BitmapEffect value for the Visual. Inherited from Visual. |
VisualBitmapEffectInput protected | Gets or sets the BitmapEffectInput value for the Visual. Inherited from Visual. |
VisualBitmapScalingMode protected | Gets or sets the BitmapScalingMode for the Visual. Inherited from Visual. |
VisualCacheMode protected | Gets or sets a cached representation of the Visual. Inherited from Visual. |
VisualChildrenCount protected | Gets the number of visual child elements within this element. Inherited from FrameworkElement. |
VisualClearTypeHint protected | Gets or sets the ClearTypeHint that determines how ClearType is rendered in the Visual. Inherited from Visual. |
VisualClip protected | Gets or sets the clip region of the Visual as a Geometry value. Inherited from Visual. |
VisualEdgeMode protected | Gets or sets the edge mode of the Visual as an EdgeMode value. Inherited from Visual. |
VisualEffect protected | Gets or sets the bitmap effect to apply to the Visual. Inherited from Visual. |
VisualOffset protected | Gets or sets the offset value of the visual object. Inherited from Visual. |
VisualOpacity protected | Gets or sets the opacity of the Visual. Inherited from Visual. |
VisualOpacityMask protected | Gets or sets the Brush value that represents the opacity mask of the Visual. Inherited from Visual. |
VisualParent protected | Gets the visual tree parent of the visual object. Inherited from Visual. |
VisualScrollableAreaClip protected | Gets or sets a clipped scrollable area for the Visual. Inherited from Visual. |
VisualTextHintingMode protected | Gets or sets the TextHintingMode of the Visual. Inherited from Visual. |
VisualTextRenderingMode protected | Gets or sets the TextRenderingMode of the Visual. Inherited from Visual. |
VisualTransform protected | Gets or sets the Transform value for the Visual. Inherited from Visual. |
VisualXSnappingGuidelines protected | Gets or sets the x-coordinate (vertical) guideline collection. Inherited from Visual. |
VisualYSnappingGuidelines protected | Gets or sets the y-coordinate (horizontal) guideline collection. Inherited from Visual. |
Width | Gets or sets the width of the element. Inherited from FrameworkElement. |
ZoomFactor | Specifies the current document zoom factor. This is a dependency property. Inherited from DocumentViewerControl. |
ZoomInCommand | Returns a command that zooms a displayed document out. Inherited from DocumentViewerControl. |
ZoomMode | Specifies the current document zoom mode. This is a dependency property. Inherited from DocumentViewerControl. |
ZoomOutCommand | Returns a command that zooms a displayed document out. Inherited from DocumentViewerControl. |
See Also