In This Article

DocumentReference Class

Provides a simple document reference implementation.

public class DocumentReference : DependencyObject, IDocumentReference
Inheritance:
object object
Implements:
IDocumentReference

Constructors

DocumentReference()

Initializes an instance of the class.

public DocumentReference()

DocumentReference(Uri)

Initializes an instance of the class.

public DocumentReference(Uri location)
Parameter Type Description
location Uri

A System.Uri indicating the location of the document.

Properties

Description

The optional description of the document.

public string? Description { get; set; }

Property Value

string

Remarks

For a file, this can be a general file type description or a more display-oriented version of its location.

ImageSourceLarge

The optional large ImageSource for the document.

public ImageSource? ImageSourceLarge { get; set; }

Property Value

ImageSource

Remarks

This property can be used by UI that represents the document.

ImageSourceSmall

The optional small ImageSource for the document.

public ImageSource? ImageSourceSmall { get; set; }

Property Value

ImageSource

Remarks

This property can be used by UI that represents the document.

IsPinnedRecentDocument

Indicates whether the document is pinned on the recent document list.

public bool IsPinnedRecentDocument { get; set; }

Property Value

bool:

true if the document is pinned on the recent document list; otherwise, false.

LastOpenedDateTime

A DateTime indicating when the document was last opened.

public DateTime LastOpenedDateTime { get; set; }

Property Value

DateTime

Location

A System.Uri indicating the location of the document.

public Uri? Location { get; set; }

Property Value

Uri

Remarks

For a file, this is typically the full path to the file, including filename.

Name

The name of the document.

public string? Name { get; set; }

Property Value

string

Remarks

For a file, this is typically the filename (including extension) but without path.

Tag

An arbitrary object value that can be used to store custom information about this document reference.

public object? Tag { get; set; }

Property Value

object

Fields

DescriptionProperty

Defines the Description property.

public static readonly DependencyProperty DescriptionProperty

ImageSourceLargeProperty

Defines the ImageSourceLarge property.

public static readonly DependencyProperty ImageSourceLargeProperty

ImageSourceSmallProperty

Defines the ImageSourceSmall property.

public static readonly DependencyProperty ImageSourceSmallProperty

IsPinnedRecentDocumentProperty

Defines the IsPinnedRecentDocument property.

public static readonly DependencyProperty IsPinnedRecentDocumentProperty

LastOpenedDateTimeProperty

Defines the LastOpenedDateTime property.

public static readonly DependencyProperty LastOpenedDateTimeProperty

LocationProperty

Defines the Location property.

public static readonly DependencyProperty LocationProperty

NameProperty

Defines the Name property.

public static readonly DependencyProperty NameProperty

TagProperty

Defines the Tag property.

public static readonly DependencyProperty TagProperty

Extension Methods