Widget Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Widget data
[System.Runtime.Serialization.DataContract]
public class Widget : Microsoft.TeamFoundation.Dashboards.WebApi.DashboardSecuredObjecttype Widget = class
inherit DashboardSecuredObjectPublic Class Widget
Inherits DashboardSecuredObject- Inheritance
- Derived
- Attributes
Constructors
| Name | Description |
|---|---|
| Widget() | |
Properties
| Name | Description |
|---|---|
| AllowedSizes |
Refers to the allowed sizes for the widget. This gets populated when user wants to configure the widget |
| AreSettingsBlockedForUser |
Read-Only Property from Dashboard Service. Indicates if settings are blocked for the current user. |
| ArtifactId |
Refers to unique identifier of a feature artifact. Used for pinning+unpinning a specific artifact. |
| CanStoreCrossProjectSettings | |
| ConfigurationContributionId | |
| ConfigurationContributionRelativeId | |
| ContentUri | |
| ContributionId |
The id of the underlying contribution defining the supplied Widget Configuration. |
| Dashboard |
Optional partial dashboard content, to support exchanging dashboard-level version ETag for widget-level APIs |
| ETag | |
| Id | |
| IsEnabled | |
| IsNameConfigurable | |
| LightboxOptions | |
| Links | |
| LoadingImageUrl | |
| Name | |
| Position | |
| Settings | |
| SettingsVersion | |
| Size | |
| TypeId | |
| Url | |
Methods
| Name | Description |
|---|---|
| IsNew() | |
| IsPositioned() | |
| SetMetaData(WidgetMetadata) |
Applies metadata about the widget. If metadata is not enabled for the current user, omit the settings payload, to protect widgets which have not explicitly been targeted for public use. (Settings only matter to enabled widgets) |
| SetSecuredChildren(ISecuredObject) | |
| SetSecuredObject(ISecuredObject) |
Operation to populate SecuredObject Info on object and all children with same security state. (Inherited from DashboardSecuredObject) |
Explicit Interface Implementations
| Name | Description |
|---|---|
| ISecuredObject.GetToken() | (Inherited from DashboardSecuredObject) |
| ISecuredObject.NamespaceId | (Inherited from DashboardSecuredObject) |
| ISecuredObject.RequiredPermissions | (Inherited from DashboardSecuredObject) |