ViewData Class |
Base data contract class for returning a View through the REST API.
Inheritance HierarchySystemObject
Dundas.BI.WebApi.ModelsBaseDataContract
Dundas.BI.WebApi.ModelsFileData
Dundas.BI.WebApi.ModelsEntityBaseData
Dundas.BI.WebApi.ModelsViewData
Dundas.BI.WebApi.ModelsBaseDataContract
Dundas.BI.WebApi.ModelsFileData
Dundas.BI.WebApi.ModelsEntityBaseData
Dundas.BI.WebApi.ModelsViewData
Namespace: Dundas.BI.WebApi.Models
Assembly: Dundas.BI.WebApi (in Dundas.BI.WebApi.dll) Version: 2.0.0.0 (10.0.0.1002)
SyntaxThe ViewData type exposes the following members.
ConstructorsProperties| Name | Description | |
|---|---|---|
 | Adapters |
Gets the Adapters.
|
| Background |
Gets or sets the background.
|
| BeforeExportActions |
Gets the before export actions.
|
| BrushViewParameterId |
Gets or sets the ID of the brush view parameter.
|
| CheckedOutTo |
Gets information about the account to which the object is checked out.
(Inherited from FileData.) |
| ChildCount | Gets the number of direct children contained in the entry. (Inherited from FileData.) |
| CreatedBy |
Gets the account information for the user which created the entry.
(Inherited from FileData.) |
| CreatedTime |
Gets the time, in coordinated universal time (UTC), at which the entry was created.
(Inherited from FileData.) |
| CurrentRevision | Gets the highest revision number associated with this file. (Inherited from FileData.) |
| Description |
Gets an optional description associated with the entry.
(Inherited from FileData.) |
| DisabledApplicationPrivileges |
Gets the disabled application privileges. This is a list of each application privilege ID which should be disabled regardless of the user's application-wide privilege.
|
| EffectiveCallerPrivileges |
Gets the effective caller privileges so the UI can do checks based on this.
(Inherited from FileData.) |
| ExportTimeout |
Gets or sets the export timeout override length in seconds.
|
| Files |
Gets the files contained in the entry.
(Inherited from FileData.) |
| Folders | Gets the folders contained in the entry. (Inherited from FileData.) |
| FontColor |
Gets or sets the font color.
|
| FontFamily |
Gets or sets the font family.
|
| FontSize |
Gets or sets the size of the font.
|
| FontStyle |
Gets or sets the font style.
|
| FontVariant |
Gets or sets the font variant.
|
| FontWeight |
Gets or sets the font weight.
|
| FriendlyFullName |
Gets the full path of the entry (friendly).
(Inherited from FileData.) |
| FriendlyLocation |
Gets the location of the entry (friendly representation).
(Inherited from FileData.) |
| FriendlyLocationElements |
Gets a read-only list of distinct path elements which compose FriendlyLocation.
(Inherited from FileData.) |
| FriendlyName | Gets the name of the entry (friendly representation). (Inherited from FileData.) |
| FullName |
Gets the full path of the entry.
(Inherited from FileData.) |
| Height |
Gets or sets the height.
|
| Id |
Gets the unique identifier of the entry.
(Inherited from FileData.) |
| IgnoreAspectRatioOnResize |
Gets or sets a value indicating whether this view will ignore its aspect ratio when in scale view mode or resize view mode.
|
| InheritedTags |
Gets the inherited tags, if there are any.
(Inherited from FileData.) |
| InitialViewOptions |
Gets or sets the initial view options, such as it should start full screen.
This option can be overridden by the overrides.
|
| IsAutomaticBrushingDisabled |
Gets or sets a value indicating whether automatic data brushing is disabled on this view and only
custom interactions passing values to the brush view parameter trigger data brushing.
|
| IsCheckedOut | Gets a value indicating whether the file is checked out. (Inherited from FileData.) |
| IsCheckedOutToCaller |
Gets a value indicating whether the file is checked out to caller.
(Inherited from FileData.) |
| IsInactive |
Gets a value indicating whether the file is inactive.
(Inherited from FileData.) |
| IsProtected | Gets a value indicating whether the entry is protected. (Inherited from FileData.) |
| IsRecycled | Gets a value indicating whether the entry is recycled. (Inherited from FileData.) |
| IsSubentry |
Gets a value indicating whether the entry is contained by a File.
(Inherited from FileData.) |
| IsTemplate |
Gets or sets a value indicating whether this dashboard is a template.
This property is set to the File, and as such,
applies to all instances (not just the checked out version) of this object.
|
| IsTransient | Gets a value indicating whether the file is transient. (Inherited from FileData.) |
| LastCheckedInTime | Gets the time when the file was last checked in. (Inherited from FileData.) |
| LastModifiedTime |
Gets the time, in coordinated universal time (UTC), at which the entry was last modified.
(Inherited from FileData.) |
| Layers |
Gets the layers.
|
| LoadingActions |
Gets the loading actions.
|
| Location | Gets the location of the entry. (Inherited from FileData.) |
| Metadata | Gets arbitrary metadata associated with the entry. (Inherited from FileData.) |
| Name |
Gets the name of the entry.
(Inherited from FileData.) |
| ObjectType |
Gets the type of the entry.
(Inherited from FileData.) |
| Overwrite |
Gets or sets a value indicating whether the file should be overwritten if the file was already created.
(Inherited from FileData.) |
| ParameterAdapters |
Gets the collection of global parameter adapters that are shown in the parameter bar when viewing.
|
| ParentId |
Gets the ID of the item's parent.
(Inherited from FileData.) |
| PrimaryEntryId | Gets the ID of the primary object which contains the entry. (Inherited from FileData.) |
| PrivilegeInheritanceBehavior |
Gets the privilege inheritance behavior.
(Inherited from FileData.) |
| Privileges |
Gets the entry's privilege assignments.
(Inherited from FileData.) |
| ProjectId |
Gets the ID of the project containing the entry.
(Inherited from FileData.) |
| ReadyActions |
Gets the ready actions.
|
| RelativeFontSizeMax |
Gets or sets the minimum font size relative font size is limited to.
|
| RelativeFontSizeMin |
Gets or sets the minimum font size relative font size is limited to.
|
| RelativeFontSizeResizeStrength |
Gets or sets the strength for resizing relative font size.
|
| RepeaterModel |
Gets or sets the repeater model.
|
| ResizeActions |
Gets the resize actions.
|
| ResizeMode |
Gets or sets the resize mode.
|
| ResizeModeFit |
Gets or sets the resize mode fit.
This only applies when ResizeMode is Resize.
|
| Revision | Gets the revision of this instance. (Inherited from EntityBaseData.) |
| Subtype | Gets or sets the type-specific sub-type of the entry. (Inherited from FileData.) |
| Tags |
Gets a collection of explicit tags associated with the entry.
(Inherited from FileData.) |
| TemplateCellHorizontalSpacing |
Gets or sets the template cell horizontal spacing.
|
| TemplateCells |
Gets the template cells.
|
| TemplateCellsHorizontalPadding |
Get or sets the horizontal padding of the canvas to the template cells.
|
| TemplateCellsVerticalPadding |
Get or sets the vertical padding of the canvas to the template cells.
|
| TemplateCellVerticalSpacing |
Gets or sets the template cell vertical spacing.
|
| TemplateDefinition |
Gets or sets the template definition. This will only be populated if
TemplateId is non-empty.
|
| TemplateId |
Gets or sets the ID of the template.
|
| TenantId |
Gets the ID of the tenant associated with the entry.
(Inherited from FileData.) |
| UIClassName |
Gets or sets the name of the UI class (used for auto de-serialization).
(Inherited from BaseDataContract.) |
| UndoContext |
If available, the current undo context for the entity.
(Inherited from EntityBaseData.) |
| Version |
Gets or sets the version of the entity.
|
| ViewParameters |
Gets the view parameters.
|
| ViewType |
Gets the view type.
|
| Warnings |
Gets the warnings for the current instance, as well as for any dependency objects.
(Inherited from FileData.) |
| Width |
Gets or sets the width.
|
Methods| Name | Description | |
|---|---|---|
  | FromDataContractMappings |
The mapping from ViewData to View.
|
| ToDataContractMappings |
The mapping from View to ViewData.
|
Extension Methods| Name | Description | |
|---|---|---|
 | SetUIClassName(FileSystemEntry) | Overloaded.
Sets the name of the file data UI class.
(Defined by ModelDataExtensions.) |
| SetUIClassName(View) | Overloaded.
Sets the name of the view data UI class.
(Defined by ModelDataExtensions.) |
See Also