FileVersion - класс

Версия файла.

Definition

Пространство имён: Tessa.Files
Сборка: Tessa (в Tessa.dll) Версия: 4.0.4
C#
public class FileVersion : FileObject, 
	IFileVersion, IFileObject, IFileEntity, IEquatable<IFileEntity>, 
	INotifyPropertyChanged, IEquatable<IFileObject>, IEquatable<IFileVersion>
Inheritance
Object    NotificationObject    FileEntity    FileObject    FileVersion
Implements
INotifyPropertyChanged, IEquatableIFileEntity, IEquatableIFileObject, IEquatableIFileVersion, IFileEntity, IFileObject, IFileVersion

Заметки

Наследники класса могут содержать дополнительные свойства, связанные с внешней подсистемой, в которой располагается файл.

Конструкторы

FileVersion Создаёт экземпляр класса с указанием значений его свойств.

Свойства

Cancellation Объект, который может использоваться для отмены асинхронных операций с файлом или версией файла, которые поддерживают отмену. На текущий момент это доступно для загрузки содержимого версии файла.
(Унаследован от FileObject)
Content Контент файла или версии файла. Контент файла обычно равен контенту его последней версии, но имя файла на файловой системе может отличаться.
(Унаследован от FileObject)
ContentSource Местоположение контента версии файла.
ContentState Состояние загрузки контента файла или версии файла в кэш для последующего отображения пользователю.
(Унаследован от FileObject)
Created Дата создания версии.
CreatedByID Идентификатор пользователя, который создал версию.
CreatedByName Имя пользователя, который создал версию.
ErrorInfo Информация по ошибке, возникшей при сохранении версии файла, или null, если ошибок не было.
File Файл, к которому относится версия. Свойства файла имеют текущее состояние, а не таковое на момент создания версии.
Hash Хеш контента файла или версии файла, или null, если хеш не вычислен. Хеш является необязательным свойством, которое по умолчанию не заполняется системой.
(Унаследован от FileObject)
ID Идентификатор объекта.
(Унаследован от FileEntity)
Info Дополнительная информация, используемая в расширениях.
(Унаследован от FileObject)
LinkID Внешний идентификатор версии файла или null, если такой идентификатор не задан. Может использоваться в расширениях для связи с содержимым во внешнем местоположении.
Name Имя файла или версии файла, которое является допустимым именем файла на файловой системе, но может отличаться от отображаемого имени файла.
(Унаследован от FileObject)
Number Порядковый номер версии файла, отсчитываемый от 1.
Options Настройки файла или версии файла. Сериализуются в карточке в форме JSON.
(Унаследован от FileObject)
RequestInfo Дополнительная пользовательская информация, передаваемая в запросы к серверу, которые относятся к загрузке содержимого файла/версии, к загрузке списка версий файла или к загрузке списка подписей.
(Унаследован от FileObject)
Signatures Подписи для версии файла.
Size Размер файла или версии файла в байтах. Устанавливается при создании объекта и затем обновляется в зависимости от действительного размера контента Size. Значение UnknownSize определяет, что размер неизвестен.
(Унаследован от FileObject)
Source Объект, обеспечивающий взаимодействие текущего объекта с подсистемой, в которой он был создан, например, с карточкой.
(Унаследован от FileEntity)
State Состояние версии файла.
Tags Теги, связанные с версией файла. Например, признак того, что размер содержимого файла трактуется как большой файл, поэтому файл не копируется во временную папку.

Методы

Equals(IFileEntity)Indicates whether the current object is equal to another object of the same type.
(Унаследован от FileEntity)
Equals(IFileObject)Indicates whether the current object is equal to another object of the same type.
(Унаследован от FileObject)
Equals(IFileVersion)Сравнивает текущий объект с заданным.
Equals(Object)Determines whether the specified object is equal to the current object.
(Унаследован от FileEntity)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Унаследован от Object)
GetHashCodeServes as the default hash function.
(Унаследован от FileEntity)
GetTypeGets the Type of the current instance.
(Унаследован от Object)
InvalidateContentAsync Удаляет локально загруженный контент, переводя его в начальное состояние. Следующий раз при получении контента он будет заново загружен.
(Унаследован от FileObject)
MemberwiseCloneCreates a shallow copy of the current Object.
(Унаследован от Object)
OnContentPropertyChanged Обработчик события на изменение свойства для контента текущего объекта Content.
(Унаследован от FileObject)
OnPropertyChanged(PropertyChangedEventArgs) Уведомляет об изменении свойства с именем, заданным в аргументах события.
(Унаследован от NotificationObject)
OnPropertyChanged(String) Уведомляет об изменении свойства с заданным именем у объекта.
(Унаследован от NotificationObject)
OnPropertyChangedAsync(PropertyChangedEventArgs, Boolean) Уведомляет об изменении свойства с именем, заданным в аргументах события, асинхронно, в соответствии с принятым для текущего объекта поведением. Если есть возможность вызвать событие синхронно, то оно вызывается синхронно. Если объект является моделью представления WPF и текущий поток отличен от потока диспетчера WPF для приложения (основной поток UI), то выполнение асинхронно переключается в этот поток. Если это не так, то событие выполняется синхронно.
(Унаследован от NotificationObject)
OnPropertyChangedAsync(String, Boolean) Уведомляет об изменении свойства с заданным именем у объекта асинхронно, в соответствии с принятым для текущего объекта поведением. Если есть возможность вызвать событие синхронно, то оно вызывается синхронно. Если объект является моделью представления WPF и текущий поток отличен от потока диспетчера WPF для приложения (основной поток UI), то выполнение асинхронно переключается в этот поток. Если это не так, то событие выполняется синхронно.
(Унаследован от NotificationObject)
SetContentStateAsync Устанавливает состояние загрузки контента файла или версии файла в кэш для последующего отображения пользователю.
(Унаследован от FileObject)
SetHashAsync Устанавливает хеш контента файла или версии файла, или null, если хеш не вычислен. Хеш является необязательным свойством, которое по умолчанию не заполняется системой.
(Унаследован от FileObject)
SetNameAsync Устанавливает имя файла или версии файла, которое является допустимым именем файла на файловой системе, но может отличаться от отображаемого имени файла.
(Унаследован от FileObject)
SetSizeAsync Устанавливает размер файла или версии файла в байтах.
(Унаследован от FileObject)
ToStringReturns a string that represents the current object.
(Унаследован от FileObject)

События

PropertyChangedСобытие, уведомляющее об изменении свойства с определённым именем у модели представления.
(Унаследован от NotificationObject)

Методы расширения

AllocateAdditionalLocalContentAsync Создаёт дополнительный объект локального содержимого (на диске) для файла или версии файла. Загрузка такого содержимого отменяется вместе с основным содержимым.
(Определяется FileExtensions)
CancelDownloadingContent Отменяет асинхронную загрузку содержимого файла или версии. При отмене загрузки файла также отменяется загрузка всех его версий.
(Определяется FileExtensions)
EnsureContentDownloadedAsync Загружает контент файла или версии файла, если он ещё не был загружен. На загруженном контенте вызывается метод EnsureLocalUpdatedAsync(CancellationToken).
(Определяется FileExtensions)
EnsureContentDownloadedInUIAsync

Загружает контент файла или версии файла, если он ещё не был загружен. На загруженном контенте вызывается метод EnsureLocalUpdatedAsync(CancellationToken).

Изменение состояния контента выполняется в основном потоке UI, если выполнение производится на клиенте, и в текущем потоке, если выполнение производится посредством серверного API.


(Определяется FileExtensions)
EnsureSignaturesLoadedAsync Загружает подписи для версии файла, если они ещё не были загружены.
(Определяется FileExtensions)
Get
(Определяется ComHelper)
GetActionName Возвращает имя действия, в рамках которого был создан файл или версия файла, или null, если файл не был создан специальным способом.
(Определяется FileExtensions)
GetLinkAsync Возвращает ссылку на версию файла.
(Определяется FileExtensions)
Invoke
(Определяется ComHelper)
IsLarge Возвращает признак того, что содержимое версии файла считается большим файлом, поэтому будет обрабатываться особым образом. Проверка выполняется по наличию тега Large.
(Определяется FileExtensions)
IsValidForContentOperations Возвращает признак того, что заданный объект (файл или версия файла) может участвовать в операциях, связанных с контентом. Обычно это означает, что при загрузке контента не возникло ошибок и контент полностью загружен на сервер (не находится в процессе загрузки). При этом на клиент контент мог ещё не быть загружен, т.е. потребуется вызвать EnsureContentDownloadedAsync(IFileObject, FuncIFileObject, FileContentDownloadState, FuncFileContentDownloadState, CancellationToken, ValueTask, FuncIFileObject, CancellationToken, ValueTaskIFileContent, CancellationToken).
(Определяется FileExtensions)
OpenAsync Открывает контент заданного файла или версии файла для чтения или для редактирования.
(Определяется FileExtensions)
OpenInFolderAsync Открывает контент заданного файла или версии файла для чтения или для редактирования в окне проводника.
(Определяется FileExtensions)
ReadAllBytesAsync

Возвращает контент файла или версии файла в виде массива байт. Контент должен быть уже загружен методом EnsureContentDownloadedAsync(IFileObject, FuncIFileObject, FileContentDownloadState, FuncFileContentDownloadState, CancellationToken, ValueTask, FuncIFileObject, CancellationToken, ValueTaskIFileContent, CancellationToken) или EnsureContentDownloadedInUIAsync(IFileObject, FuncIFileObject, CancellationToken, ValueTaskIFileContent, CancellationToken).

Этот метод оптимизирован по потреблению памяти, поэтому для получения данных рекомендуется использовать именно его.


(Определяется FileExtensions)
ReadAllTextAsync

Возвращает контент текстового файла или версии файла в виде строки. Контент должен быть уже загружен методом EnsureContentDownloadedAsync(IFileObject, FuncIFileObject, FileContentDownloadState, FuncFileContentDownloadState, CancellationToken, ValueTask, FuncIFileObject, CancellationToken, ValueTaskIFileContent, CancellationToken) или EnsureContentDownloadedInUIAsync(IFileObject, FuncIFileObject, CancellationToken, ValueTaskIFileContent, CancellationToken).

Этот метод оптимизирован по потреблению памяти, поэтому для получения данных рекомендуется использовать именно его.


(Определяется FileExtensions)
ReadBase64Async Возвращает контент файла или версии файла в виде строки формата base64. Контент должен быть уже загружен методом EnsureContentDownloadedAsync(IFileObject, FuncIFileObject, FileContentDownloadState, FuncFileContentDownloadState, CancellationToken, ValueTask, FuncIFileObject, CancellationToken, ValueTaskIFileContent, CancellationToken) или EnsureContentDownloadedInUIAsync(IFileObject, FuncIFileObject, CancellationToken, ValueTaskIFileContent, CancellationToken).
(Определяется FileExtensions)
RestoreDownloadingContentAfterCancel Восстанавливает возможность асинхронной загрузки содержимого файла или версии после отмены. При восстановлении загрузки файла также восстанавливается загрузка всех его версий.
(Определяется FileExtensions)
SaveAsync Сохраняет контент заданного файла или версии файла в файле с указанным именем.
(Определяется FileExtensions)
SaveAsync Сохраняет контент заданного файла или версии файла в файле с указанным именем.
(Определяется FileExtensions)
Set
(Определяется ComHelper)
SetActionName Устанавливает имя действия, в рамках которого был создан файл или версия файла. Например: FileMenuActionNames.Scan или FileMenuActionNames.AddFromTemplate.
(Определяется FileExtensions)
TryGetActualFile Возвращает объект IFile, соответствующей переданному файлу или файлу переданной версии. Возвращает null, если переданный объект не является файлом IFile или версией IFileVersion.
(Определяется FileExtensions)
TryGetActualVersion Возвращает объект IFileVersion, соответствующей переданной версии или последней версии переданного файла. Возвращает null, если переданный объект не является файлом IFile или версией IFileVersion.
(Определяется FileExtensions)

См. также