FileObject - класс

Базовый объект для файлов и версий файлов.

Definition

Пространство имён: Tessa.Files
Сборка: Tessa (в Tessa.dll) Версия: 3.6.0.24

C#
public abstract class FileObject : FileEntity, 
	IFileObject, IFileEntity, IEquatable<IFileEntity>, INotifyPropertyChanged, 
	IEquatable<IFileObject>

VB
Public MustInherit Class FileObject
	Inherits FileEntity
	Implements IFileObject, IFileEntity, IEquatable(Of IFileEntity), 
	INotifyPropertyChanged, IEquatable(Of IFileObject)

C++
public ref class FileObject abstract : public FileEntity, 
	IFileObject, IFileEntity, IEquatable<IFileEntity^>, INotifyPropertyChanged, 
	IEquatable<IFileObject^>

F#
[<AbstractClassAttribute>]
type FileObject = 
    class
        inherit FileEntity
        interface IFileObject
        interface IFileEntity
        interface IEquatable<IFileEntity>
        interface INotifyPropertyChanged
        interface IEquatable<IFileObject>
    end

Inheritance: Object NotificationObject FileEntity FileObject

Derived: Tessa.Files.File
Tessa.Files.FileVersion

Implements: INotifyPropertyChanged, IEquatable<IFileEntity>, IEquatable<IFileObject>, IFileEntity, IFileObject

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

FileObject

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

Свойства

Cancellation	Объект, который может использоваться для отмены асинхронных операций с файлом или версией файла, которые поддерживают отмену. На текущий момент это доступно для загрузки содержимого версии файла.
Content	Контент файла или версии файла. Контент файла обычно равен контенту его последней версии, но имя файла на файловой системе может отличаться.
ContentState	Состояние загрузки контента файла или версии файла в кэш для последующего отображения пользователю.
Hash	Хеш контента файла или версии файла, или null, если хеш не вычислен. Хеш является необязательным свойством, которое по умолчанию не заполняется системой.
ID	Идентификатор объекта. (Унаследован от FileEntity)
Info	Дополнительная информация, используемая в расширениях.
Name	Имя файла или версии файла, которое является допустимым именем файла на файловой системе, но может отличаться от отображаемого имени файла.
Options	Настройки файла или версии файла. Сериализуются в карточке в форме JSON.
RequestInfo	Дополнительная пользовательская информация, передаваемая в запросы к серверу, которые относятся к загрузке содержимого файла/версии, к загрузке списка версий файла или к загрузке списка подписей.
Size	Размер файла или версии файла в байтах. Устанавливается при создании объекта и затем обновляется в зависимости от действительного размера контента [IFileContent.Size]. Значение [FileContent.UnknownSize] определяет, что размер неизвестен.
Source	Объект, обеспечивающий взаимодействие текущего объекта с подсистемой, в которой он был создан, например, с карточкой. (Унаследован от FileEntity)

Методы

Equals(IFileEntity)	Сравнивает текущий объект с заданным. (Унаследован от FileEntity)
Equals(IFileObject)	Сравнивает текущий объект с заданным.
Equals(Object)	Сравнивает текущий объект с заданным. (Унаследован от FileEntity)
Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Унаследован от Object)
GetHashCode	Возвращает хеш-код объекта. (Унаследован от FileEntity)
GetType	Gets the Type of the current instance. (Унаследован от Object)
InvalidateContentAsync	Удаляет локально загруженный контент, переводя его в начальное состояние. Следующий раз при получении контента он будет заново загружен.
MemberwiseClone	Creates a shallow copy of the current Object. (Унаследован от Object)
OnContentPropertyChanged	Обработчик события на изменение свойства для контента текущего объекта [IFileObject.Content].
OnPropertyChanged(PropertyChangedEventArgs)	Уведомляет об изменении свойства с именем, заданным в аргументах события. (Унаследован от NotificationObject)
OnPropertyChanged(String)	Уведомляет об изменении свойства с заданным именем у объекта. (Унаследован от NotificationObject)
OnPropertyChangedAsync(PropertyChangedEventArgs, Boolean)	Уведомляет об изменении свойства с именем, заданным в аргументах события, асинхронно, в соответствии с принятым для текущего объекта поведением. Если есть возможность вызвать событие синхронно, то оно вызывается синхронно. Если объект является моделью представления WPF и текущий поток отличен от потока диспетчера WPF для приложения (основной поток UI), то выполнение асинхронно переключается в этот поток. Если это не так, то событие выполняется синхронно. (Унаследован от NotificationObject)
OnPropertyChangedAsync(String, Boolean)	Уведомляет об изменении свойства с заданным именем у объекта асинхронно, в соответствии с принятым для текущего объекта поведением. Если есть возможность вызвать событие синхронно, то оно вызывается синхронно. Если объект является моделью представления WPF и текущий поток отличен от потока диспетчера WPF для приложения (основной поток UI), то выполнение асинхронно переключается в этот поток. Если это не так, то событие выполняется синхронно. (Унаследован от NotificationObject)
SetContentStateAsync	Устанавливает состояние загрузки контента файла или версии файла в кэш для последующего отображения пользователю.
SetHashAsync	Устанавливает хеш контента файла или версии файла, или null, если хеш не вычислен. Хеш является необязательным свойством, которое по умолчанию не заполняется системой.
SetNameAsync	Устанавливает имя файла или версии файла, которое является допустимым именем файла на файловой системе, но может отличаться от отображаемого имени файла.
SetSizeAsync	Устанавливает размер файла или версии файла в байтах.
ToString	Возвращает строковое представление объекта. (Переопределяет FileEntity.ToString())

События

PropertyChanged

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

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

AllocateAdditionalLocalContentAsync	Создаёт дополнительный объект локального содержимого (на диске) для файла или версии файла. Загрузка такого содержимого отменяется вместе с основным содержимым. (Определяется FileExtensions)
CancelDownloadingContent	Отменяет асинхронную загрузку содержимого файла или версии. При отмене загрузки файла также отменяется загрузка всех его версий. (Определяется FileExtensions)
EnsureContentDownloadedAsync	Загружает контент файла или версии файла, если он ещё не был загружен. На загруженном контенте вызывается метод [IFileContent.EnsureLocalUpdatedAsync]. (Определяется FileExtensions)
EnsureContentDownloadedInUIAsync	Загружает контент файла или версии файла, если он ещё не был загружен. На загруженном контенте вызывается метод [IFileContent.EnsureLocalUpdatedAsync]. Изменение состояния контента выполняется в основном потоке UI, если выполнение производится на клиенте, и в текущем потоке, если выполнение производится посредством серверного API. (Определяется FileExtensions)
Get	(Определяется ComHelper)
GetActionName	Возвращает имя действия, в рамках которого был создан файл или версия файла, или null, если файл не был создан специальным способом. (Определяется FileExtensions)
InternalMarkerCanvas	Возвращает маркер аннотации (Определяется AnnotationInternalsAccessor)
Invoke	(Определяется ComHelper)
IsValidForContentOperations	Возвращает признак того, что заданный объект (файл или версия файла) может участвовать в операциях, связанных с контентом. Обычно это означает, что при загрузке контента не возникло ошибок и контент полностью загружен на сервер (не находится в процессе загрузки). При этом на клиент контент мог ещё не быть загружен, т.е. потребуется вызвать EnsureContentDownloadedAsync(IFileObject, Func<IFileObject, FileContentDownloadState>, Func<FileContentDownloadState, CancellationToken, ValueTask>, Func<IFileObject, CancellationToken, ValueTask<IFileContent>>, CancellationToken). (Определяется FileExtensions)
OpenAsync	Открывает контент заданного файла или версии файла для чтения или для редактирования. (Определяется FileExtensions)
OpenInFolderAsync	Открывает контент заданного файла или версии файла для чтения или для редактирования в окне проводника. (Определяется FileExtensions)
ReadAllBytesAsync	Возвращает контент файла или версии файла в виде массива байт. Контент должен быть уже загружен методом EnsureContentDownloadedAsync(IFileObject, Func<IFileObject, FileContentDownloadState>, Func<FileContentDownloadState, CancellationToken, ValueTask>, Func<IFileObject, CancellationToken, ValueTask<IFileContent>>, CancellationToken) или EnsureContentDownloadedInUIAsync(IFileObject, Func<IFileObject, CancellationToken, ValueTask<IFileContent>>, CancellationToken). Этот метод оптимизирован по потреблению памяти, поэтому для получения данных рекомендуется использовать именно его. (Определяется FileExtensions)
ReadAllTextAsync	Возвращает контент текстового файла или версии файла в виде строки. Контент должен быть уже загружен методом EnsureContentDownloadedAsync(IFileObject, Func<IFileObject, FileContentDownloadState>, Func<FileContentDownloadState, CancellationToken, ValueTask>, Func<IFileObject, CancellationToken, ValueTask<IFileContent>>, CancellationToken) или EnsureContentDownloadedInUIAsync(IFileObject, Func<IFileObject, CancellationToken, ValueTask<IFileContent>>, 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)

См. также

Ссылки

Tessa.Files - пространство имён