Для изменения размера нажмите или перетащите

RemoteFileContent - класс

Контент файла, доступный удалённо с использованием заданных функций.
Иерархия наследования

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

Тип RemoteFileContent предоставляет следующие члены.

Конструкторы
  ИмяОписание
Открытый методRemoteFileContent
Создаёт контент с указанием используемых функций. После вызова конструктора объекта требуется инициализировать методом InitializeAsync(CancellationToken).
В начало страницы
Свойства
  ИмяОписание
Открытое свойствоCancellation
Объект, который может использоваться для отмены асинхронных операций с содержимым файла, если оно поддерживает отмену. На текущий момент это доступно для загрузки содержимого версии файла.
(Унаследован от FileContent.)
Защищённое свойствоGetContentFuncAsync
Функция, открывающая и возвращающая поток с данными. Не равна null.
Защищённое свойствоGetSizeFuncAsync
Функция, возвращающая размер потока с данными GetContentFuncAsync. Не равна null.
Защищённое свойствоHasCurrentContentData
Данные для получения контента всегда присутствуют. При получении значения свойство возвращает true. При установке значения не выполняется действий.
(Переопределяет FileContentHasCurrentContentData.)
Открытое свойствоHasData
Возвращает признак того, что контент файла был установлен методом [IFileContent.Set].
(Унаследован от FileContent.)
Открытое свойствоIsBoundToFileSource
Признак того, что контент был создан источником файлов, а не передан снаружи, поэтому для оптимизации обращения к содержимому можно использовать источник файлов. Обычно актуально для Remote-контента.
(Переопределяет FileContentIsBoundToFileSource.)
Открытое свойствоIsDirty
Признак того, что контент мог быть изменён. Следует установить значение равным true перед открытием контента на редактирование во внешней программе. Определить точно, был ли изменён контент, можно, вызвав метод [IFileContent.IsModified].
(Унаследован от FileContent.)
Открытое свойствоIsDisposed
Признак того, что контент был освобождён и объект нельзя использовать.
(Унаследован от FileContent.)
Открытое свойствоIsLocal
Признак того, что контент является локальным, т.е. к нему можно получить локальный путь посредством метода [IFileContent.GetLocalFilePath].
(Переопределяет FileContentIsLocal.)
Открытое свойствоIsSealed
Признак того, что объект был защищён от изменений.
(Унаследован от FileContent.)
Открытое свойствоParent
Родительский контент или null, если родительский контент отсутствует. Если производится запрос текущего контента, и он не был установлен, то он сначала локально копируется из родительского, если тот существует, а затем считывается локально.
(Унаследован от FileContent.)
Открытое свойствоRequestInfo
Дополнительная пользовательская информация, передаваемая в запросы к серверу, которые относятся к загрузке содержимого файла или версии, которые сохраняются в текущем объекте. Рекомендуется, чтобы все данные были сериализуемых типов (в соответствии с типовой BSON-сериализацией в системе). Такие данные могут перезаписать данные из [IFileObject.RequestInfo].
(Унаследован от FileContent.)
Открытое свойствоSize
Размер контента файла в байтах или 0, если контент ещё не был загружен. Проверить, был ли загружен контент, можно, обратившись к свойству [IFileContent.HasData].
(Унаследован от FileContent.)
Открытое свойствоUri
Ссылка к контенту файла, который может быть доступен как локально (на диске), так и удалённо (сетевой ресурс). Значение может быть равно null, если контент недоступен по ссылке.
(Переопределяет FileContentUri.)
В начало страницы
Методы
  ИмяОписание
Защищённый методCheckDisposed
Выбрасывает исключение [ObjectDisposedException], если ресурсы текущего объекта были освобождены.
(Унаследован от FileContent.)
Защищённый методCheckSealed
Выбрасывает исключение [Tessa.Platform.ObjectSealedException], если объект был защищён от изменений.
(Унаследован от FileContent.)
Открытый методDisposeAsync
Освобождает ресурсы, занимаемые объектом.
(Унаследован от FileContent.)
Защищённый методDisposeAsync(Boolean)
Освобождает ресурсы, занимаемые объектом.
(Унаследован от FileContent.)
Открытый методEnsureLocalUpdatedAsync
Удостоверяет, что файл будет загружен локально и доступен по пути [IFileContent.GetLocalFilePath], если файл является локальным [IFileContent.IsLocal]. Если файл не локальный, то метод не выполняет действий.
(Унаследован от FileContent.)
Открытый методEnterLockAsync
Выполняет вход в блок, в пределах которого нет других обращений к контенту файла. Вызовите метод в блоке using(await content.EnterLockAsync().ConfigureAwait(false)).
(Унаследован от FileContent.)
Открытый методEquals
Determines whether the specified object is equal to the current object.
(Унаследован от Object.)
Защищённый методFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Унаследован от Object.)
Открытый методСтатический членFromContentAsync
Создаёт объект контента файла, содержимое и размер которого определяются по заданному объекту контента content.
Открытый методСтатический членFromFilePathAsync
Создаёт объект контента файла, который соответствует заданному файлу, доступному по полному пути на диске filePath.
Открытый методСтатический членFromStreamAndSizeAsync
Создаёт объект контента файла, который может быть получен по заданному функции getContentFuncAsync и имеет фиксированный (заранее вычисленный) размер. Если размер не является фиксированным, то следует использовать конструктор RemoteFileContent/
Открытый методGetAsync
Открывает и возвращает поток с контентом файла. Если контент файла отсутствует, то вызывает исключение [System.InvalidOperationException]. Поэтому перед получением контента можно обратиться к свойству [IFileContent.HasData].
(Унаследован от FileContent.)
Защищённый методGetCoreAsync
Возвращает поток с содержимым файла. Если файл не был загружен, то может быть выброшено исключение.
(Переопределяет FileContentGetCoreAsync(CancellationToken).)
Открытый методGetHashCode
Serves as the default hash function.
(Унаследован от Object.)
Открытый методGetLocalFilePath
Возвращает локальный путь к контенту файла, если контент доступен локально. Если контент не доступен локально, то вызывает исключение [System.InvalidOperationException]. Поэтому перед вызовом метода можно обратиться к свойству [IFileContent.IsLocal].
(Унаследован от FileContent.)
Защищённый методGetLocalFilePathCore
Возвращает путь к файлу с локальным контентом, даже если он ещё не был загружен, или null, если контент не представлен локальным файлом.
(Переопределяет FileContentGetLocalFilePathCore.)
Открытый методGetType
Gets the Type of the current instance.
(Унаследован от Object.)
Открытый методInitializeAsync
Выполняет асинхронную инициализацию объекта.
(Унаследован от FileContent.)
Открытый методInvalidateAsync
Удаляет локально загруженный контент, переводя его в начальное состояние. Следующий раз при получении контента он будет заново загружен.
(Унаследован от FileContent.)
Защищённый методInvalidateCoreAsync
Сбрасывает информацию о контенте файла. Например, очищает дату изменения файла. Если контент не является локальным, то может не выполнять действий.
(Переопределяет FileContentInvalidateCoreAsync(CancellationToken).)
Открытый методIsModifiedAsync
Возвращает признак того, что контент файла на диске был изменён с момента его установки методом [IFileContent.Set]. Для защищённых от изменений объектов метод всегда возвращает false.
(Унаследован от FileContent.)
Защищённый методIsModifiedCoreAsync
Возвращает признак того, что локальный контент был изменён. Например, был изменён файл на диске по дате изменения. При изменении контента может быть обновлён его размер, а также он может быть, например, помечен как изменённый в структуре карточки.
(Переопределяет FileContentIsModifiedCoreAsync(CancellationToken).)
Защищённый методMemberwiseClone
Creates a shallow copy of the current Object.
(Унаследован от Object.)
Защищённый методOnPropertyChanged(PropertyChangedEventArgs)
Уведомляет об изменении свойства с именем, заданным в аргументах события.
(Унаследован от NotificationObject.)
Защищённый методOnPropertyChanged(String)
Уведомляет об изменении свойства с заданным именем у объекта.
(Унаследован от NotificationObject.)
Защищённый методOnPropertyChangedAsync(PropertyChangedEventArgs, Boolean)
Уведомляет об изменении свойства с именем, заданным в аргументах события, асинхронно, в соответствии с принятым для текущего объекта поведением. Если есть возможность вызвать событие синхронно, то оно вызывается синхронно. Если объект является моделью представления WPF и текущий поток отличен от потока диспетчера WPF для приложения (основной поток UI), то выполнение асинхронно переключается в этот поток. Если это не так, то событие выполняется синхронно.
(Унаследован от NotificationObject.)
Защищённый методOnPropertyChangedAsync(String, Boolean)
Уведомляет об изменении свойства с заданным именем у объекта асинхронно, в соответствии с принятым для текущего объекта поведением. Если есть возможность вызвать событие синхронно, то оно вызывается синхронно. Если объект является моделью представления WPF и текущий поток отличен от потока диспетчера WPF для приложения (основной поток UI), то выполнение асинхронно переключается в этот поток. Если это не так, то событие выполняется синхронно.
(Унаследован от NotificationObject.)
Защищённый методPrepareContentLocationCoreAsync
Подготавливает местоположение контента перед его записью или перемещением в это местоположение. Например, создаёт папку на диске, если контент представлен файлом на диске.
(Переопределяет FileContentPrepareContentLocationCoreAsync(CancellationToken).)
Защищённый методRemoveContentSafeCoreAsync
Метод удаляет локальный контент, если он был создан. Если контент не является локальным, то метод не должен выполнять действий. Метод не должен выбрасывать исключений, даже критичных.
(Переопределяет FileContentRemoveContentSafeCoreAsync(CancellationToken).)
Открытый методRenameAsync
Переименовывает файл, в который записывается контент. Если файл ещё не существует, то он будет назван по-другому в момент создания. Метод гарантированно сработает только в том случае, если контент является локальным, т.е. свойство [IFileContent.IsLocal] возвращает true.
(Унаследован от FileContent.)
Защищённый методRenameCoreAsync
Переименовывает имя контента в соответствии с новым именем файла. Если контент представлен локальным файлом на диске, то метод должен переименовать этот файл. Если контент не является локальным, то метод может не выполнять действий.
(Переопределяет FileContentRenameCoreAsync(String, CancellationToken).)
Открытый методSeal
Защищает объект от изменений.
(Унаследован от FileContent.)
Открытый методSetAsync
Открывает и возвращает поток, выполняющий перезапись контента файла.
(Унаследован от FileContent.)
Защищённый методSetCoreAsync
Устанавливает содержимое файла. Если контент запрещено изменять, то может быть выброшено исключение.
(Переопределяет FileContentSetCoreAsync(Stream, CancellationToken).)
Открытый методSetLocalAsync
Устанавливает контент локального файла по заданному пути.
(Унаследован от FileContent.)
Защищённый методSetLocalCoreAsync
Устанавливает локальное содержимое файла, представленное в виде файла на диске, по заданному методу, который получает в параметре путь к файлу на диске и может его создать или изменить некоторым способом. Если содержимое файла не является локальным, то может быть выброшено исключение.
(Переопределяет FileContentSetLocalCoreAsync(FuncString, CancellationToken, ValueTask, CancellationToken).)
Открытый методSetRemoteAsync
Устанавливает содержимое файла, представленное заданными методами. Если контент запрещено изменять, то может быть выброшено исключение. Метод доступен как для локальных файлов, так и для нелокальных (remote), в т.ч. для файлов большого размера.
(Унаследован от FileContent.)
Защищённый методSetRemoteCoreAsync
Устанавливает содержимое файла, представленное заданными методами. Если контент запрещено изменять, то может быть выброшено исключение. Метод доступен как для локальных файлов, так и для нелокальных (remote), в т.ч. для файлов большого размера.
(Переопределяет FileContentSetRemoteCoreAsync(FuncCancellationToken, ValueTaskStream, FuncCancellationToken, ValueTaskInt64, CancellationToken).)
Открытый методToString
Returns a string that represents the current object.
(Унаследован от Object.)
Защищённый методUpdateLocalContentFromParentCoreAsync
Обновляет локальный контент на основании контента родительского объекта. При вызове этого метода гарантируется, что у текущего контента есть родительский контент, в котором присутствуют загруженные данные. Если контент не локальный, то метод может не выполнять действий, но не должен выбрасывать исключений.
(Переопределяет FileContentUpdateLocalContentFromParentCoreAsync(CancellationToken).)
Защищённый методUpdateModifiedCoreAsync
Обновляет информацию, на основании которой можно определить, изменялся ли контент. Например, сохраняет время изменения файла, чтобы его можно было сравнить со временем изменения в любой другой момент.
(Переопределяет FileContentUpdateModifiedCoreAsync(CancellationToken).)
Открытый методUpdateSizeAsync
Обновляет свойство с размером контента [IFileContent.Size] для загруженных файлов.
(Унаследован от FileContent.)
Защищённый методUpdateSizeCoreAsync
Обновляет размер локального контента. Возвращает true, если размер был обновлён.
(Переопределяет FileContentUpdateSizeCoreAsync(CancellationToken).)
В начало страницы
События
  ИмяОписание
Открытое событиеPropertyChanged
Событие, уведомляющее об изменении свойства с определённым именем у модели представления.
(Унаследован от NotificationObject.)
В начало страницы
Методы расширения
  ИмяОписание
Открытый метод расширенияGet (Определяется ComHelper.)
Открытый метод расширенияInternalMarkerCanvas
Возвращает маркер аннотации
(Определяется AnnotationInternalsAccessor.)
Открытый метод расширенияInvoke (Определяется ComHelper.)
Открытый метод расширенияSet (Определяется ComHelper.)
В начало страницы
Заметки
В классах-наследниках могут быть переопределены или дополнены методы.
См. также