AnnotationData Class

Base data contract object for returning an Annotation.

Inheritance Hierarchy

SystemObject
  Dundas.BI.WebApi.ModelsBaseDataContract
    Dundas.BI.WebApi.ModelsFileData
      Dundas.BI.WebApi.ModelsAnnotationData

Namespace: Dundas.BI.WebApi.Models
Assembly: Dundas.BI.WebApiCore (in Dundas.BI.WebApiCore.dll) Version: 2.0.0.0 (24.4.0.1000)

Syntax

C++

Copy

[DataContractAttribute]
public class AnnotationData : FileData

<DataContractAttribute>
Public Class AnnotationData
	Inherits FileData

[DataContractAttribute]
public ref class AnnotationData : public FileData

[<DataContractAttribute>]
type AnnotationData =  
    class
        inherit FileData
    end

The AnnotationData type exposes the following members.

Constructors

	Name	Description
	AnnotationData	Initializes a new instance of the AnnotationData class.

Top

Properties

	Name	Description
	AllReplies	Gets all replies to the annotation.
	AnnotationText	Gets or sets the annotation text.
	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.)
	DirectReplies	Gets the direct replies to the annotation.
	EffectiveCallerPrivileges	Gets the effective caller privileges so the UI can do checks based on this. (Inherited from FileData.)
	Files	Gets the files contained in the entry. (Inherited from FileData.)
	Folders	Gets the folders contained in the entry. (Inherited from FileData.)
	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.)
	Id	Gets the unique identifier of the entry. (Inherited from FileData.)
	InheritedTags	Gets the inherited tags, if there are any. (Inherited from FileData.)
	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.)
	IsTemporary	Gets a value indicating whether the entry resides under a temporary folder. (Inherited from FileData.)
	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.)
	Location	Gets the location of the entry. (Inherited from FileData.)
	MeasureValue	Gets the measure value.
	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.)
	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.)
	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.)
	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.)
	Warnings	Gets the warnings for the current instance, as well as for any dependency objects. (Inherited from FileData.)

Top

Methods

	Name	Description
	ToAnnotationDataContractMappings	Gets the mapping rules that go from a Annotation to a AnnotationData.
	ToAnnotationDataContractWithRepliesMappings	Gets the mapping rules that go from a Annotation to a AnnotationData.

Top

Extension Methods

	Name	Description
	SetUIClassName	Sets the name of the file data UI class. (Defined by ModelDataExtensions.)

Top

Reference

Dundas.BI.WebApi.Models Namespace