Configuration
Class for customizing the UI and behavior of DocViewer. If a property is set to null then the default behavior is used.
Inheritance Hierarchy
System Object: WoltersKluwerFS.Osprey.DocViewerInterface.Contracts.Data. Configuration
Namespace: WoltersKluwerFS.Osprey.DocViewerInterface.Contracts.Data
Assembly: WoltersKluwerFS.Osprey.DocViewerInterface.Contracts (in WoltersKluwerFS.Osprey.DocViewerInterface.Contracts.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax
| C# |
|
| VB |
|
| C++ |
|
| F# |
|
Constructors
| Name | Description |
|---|---|
| Configuration | Initializes a new instance of the Configuration class |
Properties
| Property Name | Description |
|---|---|
| AccordionItemBackgroundBrush | Hex color code for accordion item background |
| AccordionItemExpandedBackgroundBrush | Hex color code for accordion item background when expanded. |
| AccordionItemExpandedForegroundBrush | Hex color code for accordion item foreground when expanded |
| AccordionItemForegroundBrush | Hex color code for accordion item text |
| AccordionItemHeaderForegroundBrush | Hex color code for accordion header text |
| AdditionalXPaths | Any additional xpaths for which to prompt on the Doc Options screen. This option is only used when a list of documents is used for autoselection. If a list of xpaths is provided, the Doc Options screen will display (instead of going straight to the documents) with the specified xpaths available for data entry. Please note that the xpaths will not show up if they are still marked as suppressed in the working dictionary (or overlay dictionary). |
| ButtonBackgroundBrush | Obsolete. Hex color code for the button background. |
| ButtonForegroundBrush | Obsolete. Hex color code for the button text. |
| ButtonMouseOverBackgroundBrush | Obsolete. Hex color code for button background color when the mouse is over. |
| ButtonMousePressBackgroundBrush | Obsolete. Hex color code for button background color when the mouse is pressed. |
| ButtonPrimaryBackground1Brush | Hex color code for the background color of the primary buttons. |
| ButtonPrimaryBackground2Brush | Hex color code for the background color of the primary buttons |
| ButtonPrimaryBackgroundHover1Brush | Hex color code for the background color of the primary buttons when hovered |
| ButtonPrimaryBackgroundHover2Brush | Hex color code for the background color of the primary buttons when hovered |
| ButtonPrimaryBackgroundPress1Brush | Hex color code for the background color of the primary buttons when pressed |
| ButtonPrimaryBackgroundPress2Brush | Hex color code for the background color of the primary buttons when pressed |
| ButtonPrimaryTextBrush | Hex color code for the text color of the primary buttons |
| ButtonPrimaryTextHoverBrush | Hex color code for the text color of the primary buttons when hovered |
| ButtonPrimaryTextPressBrush | Hex color code for the text color of the primary buttons when pressed |
| ButtonSecondaryBackground1Brush | Hex color code for the background color of the secondary buttons |
| ButtonSecondaryBackground2Brush | Hex color code for the background color of the secondary buttons |
| ButtonSecondaryBackgroundHover1Brush | Hex color code for the background color of the secondary buttons when hovered |
| ButtonSecondaryBackgroundHover2Brush | Hex color code for the background color of the secondary buttons when hovered |
| ButtonSecondaryBackgroundPress1Brush | Hex color code for the background color of the secondary buttons when pressed |
| ButtonSecondaryBackgroundPress2Brush | Hex color code for the background color of the secondary buttons when pressed |
| ButtonSecondaryTextBrush | Hex color code for the text color of the secondary buttons. |
| ButtonSecondaryTextHoverBrush | Hex color code for the text color of the secondary buttons when hovered |
| ButtonSecondaryTextPressBrush | Hex color code for the text color of the secondary buttons when pressed |
| ButtonTertiaryBackground1Brush | Hex color code for the background color of the tertiary buttons |
| ButtonTertiaryBackground2Brush | Hex color code for the background color of the tertiary buttons |
| ButtonTertiaryBackgroundHover1Brush | Hex color code for the background color of the tertiary buttons when hovered. |
| ButtonTertiaryBackgroundHover2Brush | Hex color code for the background color of the tertiary buttons when hovered |
| ButtonTertiaryBackgroundPress1Brush | Hex color code for the background color of the tertiary buttons when pressed |
| ButtonTertiaryBackgroundPress2Brush | Hex color code for the background color of the tertiary buttons when pressed |
| ButtonTertiaryTextBrush | Hex color code for the text color of the tertiary buttons |
| ButtonTertiaryTextHoverBrush | Hex color code for the text color of the tertiary buttons when hovered |
| ButtonTertiaryTextPressBrush | Hex color code for the text color of the tertiary buttons when pressed |
| ComboBoxBackgroundBrush | Hex color code for combo box background |
| ComboBoxItemBackgroundBrush | Hex color code for combo box item background |
| ComboBoxItemForegroundBrush | Hex color code for combo box item foreground |
| ComboBoxItemHighlightedBackgroundBrush | Hex color code for combo box item background when the item has been selected |
| ComboBoxItemHighlightedBorderBrush | Hex color code for combo box border when it has focus. |
| ComboBoxItemMouseOverBackgroundBrush | Hex color code for combo box item background when mouse is hovering over |
| ComboBoxPopupBorderBrush | Hex color code for combo box border when it has focus. |
| DocumentDrawerBackgroundBrush | Hex color code for the doc drawer background |
| DocumentDrawerDocCountForegroundBrush | Hex color code for the document count text |
| DocumentDrawerForegroundBrush | Hex color code for the document drawer text |
| DocumentDrawerHeaderForegroundBrush | Hex color code for the document drawer header text |
| DocumentDrawerItemBackgroundBrush | Hex color code for the document drawer list item background |
| DocumentDrawerItemForegroundBrush | Hex color code for the document drawer list item text |
| DocumentDrawerTabForegroundBrush | Hex color code for the document drawer tab text |
| Extension | The data extension, if any, to apply. Value of "SBA" will apply the SBA Data Collect Extension |
| FilterAutoSelectionResultsFromDocuments | When set to "true," Docviewer will filter the autoselected documents based on the documents that are passed in. |
| FocusBorderBrush | Hex color code for the border hilight color when any non-button control has focus |
| FocusButtonBorderBrush | Hex color code for the border hilight color when any button control has focus |
| HideSessionTimeoutErrors | Flag to tell DocViewer to not display a session timeout error. If this is passed, it is assumed that the calling application will be keeping track of its own timeout and/or acting upon the 'timeout' javascript message DocViewer will pass when it has timed out |
| IsCreateDocumentVisible | Get/set the visibility of the create document button |
| IsCreatePDFVisible | Get/set the visibility of the create PDF checkbox |
| IsDocDisplayHeaderVisible | Get/set the visibility of the Doc Display header. HTML DocViewer only |
| IsDocOptionsHeaderVisible | Get/set the visibility of the "Doc Options" header. HTML DocViewer only |
| IsDocumentCompletionEnabled | Get/set indicator to activate document completion features |
| IsDocumentDrawerVisible | Get/set the visibility of the document drawer at the top of the doc view screen |
| IsPackageMenuVisible | Get/set the visibility of the package dropdown menu |
| IsReadOnly | Get/set indicator to display DocViewer in a read-only state |
| IsSummaryTrayVisibile | Get/set the visibility of the data collect pane on the left side of the doc view screen |
| PageBackgroundBrush | Hex color code for the page background |
| SelectedDocId | The desired Document to initially navigate to. Passed in the form 'PKGD.MyDocument'. |
| SelectedDocInstanceNumber | The instance number of the SelectedDoc to initially navigate to. Will default to 1. |
| SelectedDocScrollLocation | The desired y-axis scroll location within the SelectedDoc to initially navigate to. Will default to 0 |
| SelectedPackage | The package selected. This should only be provided if a list of packages was used for autoselection. This package will be the one selected on the autoselection screen instead of the first one in the list |
| SelectedScreen | The screen in DocViewer to initially navigate to. Not vital to pass. If left null and you pass a SelectedDocId, this will default to 'Documents'. If you pass this as DocOptions and pass a SelectedDocId, the doc will be cleared out |
| SmallIconBackgroundFillBrush | Hex color code for background of +, -, and ? icons when they have focus |
| SummaryTraySliderBrush | Hex color code for left hand slider background |
| SummaryTraySliderForegroundBrush | Hex color code for left hand slider text |
| SupportRequiredData | True/false indicator determining if DocViewer will look for required data with the custom overlay; places a red outline around all required fields in a particular document. |
| TextForegroundBrush | Hex color code for general text |
| TitleTextForegroundBrush | Hex color code for title text |
| TrackXPathChangesWithIndexAttribute | Flag to tell DocViewer whether or not to track xpath changes with an index attribute in the transaction and return them in the EndSession/GetSession calls |
| TrackXPathChanges | Flag to tell DocViewer whether or not to track xpath changes in the transaction and return them in the EndSession/GetSession calls |
See Also
Reference: WoltersKluwerFS.Osprey.DocViewerInterface.Contracts.Data Namespace.