Class DocumentInfo

Contains information about a document.

Inheritance

object

DocumentInfo

Namespace: ABB.Robotics.RobotStudio.Documents

Assembly: ABB.Robotics.RobotStudio.Documents.dll

Syntax

public sealed class DocumentInfo

Constructors

DocumentInfo(DocumentProvider, string, string, string, string, string, string, string, Image, long, DateTime)

Constructor

Declaration

public DocumentInfo(DocumentProvider provider, string url, string fileName, string title, string type, string author, string revision, string comments, Image preview, long fileSize, DateTime lastWrite)

Parameters

Type	Name	Description
DocumentProvider	provider
string	url
string	fileName
string	title
string	type
string	author
string	revision
string	comments
Image	preview
long	fileSize
DateTime	lastWrite

Properties

Author

Returns the author of the document.

Declaration

public string Author { get; }

Property Value

Type	Description
string

Available

Returns true if the document can be read.

Declaration

[JsonIgnore]
public bool Available { get; }

Property Value

Type	Description
bool

Comments

Returns comments for the document.

Declaration

public string Comments { get; }

Property Value

Type	Description
string

DocumentType

Returns the type of document.

Declaration

public string DocumentType { get; }

Property Value

Type	Description
string

FileName

Returns the filename of the document.

Declaration

public string FileName { get; }

Property Value

Type	Description
string

FileSize

Returns the size of the document, in bytes.

Declaration

public long FileSize { get; }

Property Value

Type	Description
long

LastWrite

Returns the last time the document was modified, in UTC.

Declaration

public DateTime LastWrite { get; }

Property Value

Type	Description
DateTime

Preview

Returns an image representing the document.

Declaration

[JsonIgnore]
public Image Preview { get; set; }

Property Value

Type	Description
Image

Provider

Returns the DocumentProvider that contains the document.

Declaration

[JsonIgnore]
public DocumentProvider Provider { get; }

Property Value

Type	Description
DocumentProvider

Revision

Returns the revision of the document.

Declaration

public string Revision { get; }

Property Value

Type	Description
string

Title

Returns the title of the document.

Declaration

public string Title { get; }

Property Value

Type	Description
string

Url

Returns the URL of the document (relative to the provider URL).

Declaration

public string Url { get; }

Property Value

Type	Description
string