FileBuilder - класс

Выполняет поэтапное создание файла с возможностью последующего добавления в коллекцию файлов.

Definition

Пространство имён: Tessa.Files
Сборка: Tessa (в Tessa.dll) Версия: 3.6.0.22
C#
public class FileBuilder : IFileBuilder
Inheritance
Object    FileBuilder
Implements
IFileBuilder

Заметки

Классы-наследники могут переопределить значения его методов, а также добавить новые методы.

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

FileBuilder Создаёт экземпляр класса с указанием коллекции, в которую может быть добавлен файл с уведомлением об изменениях.

Свойства

Author Автор файла, т.е. пользователь, создавший файл, или null, если автором является текущий пользователь.
Category Категория файла или null, если категория не указана.
ContentActionAsync Метод, инициализирующий контент файла для способа создания контента Action.
ContentFactoryAsync Функция, создающая контент файла для способа создания контента Factory.
ContentPath Полный путь к контенту файла для способа создания контента Path.
ContentStream Полный путь к потоку с контентом файла для способа создания контента Stream.
ContentType Способ создания контента файла. По умолчанию значение Undefined запрещает создание файла.
Files Коллекция, в которую может быть добавлен файл с уведомлением об изменениях.
FileTokenActionAsync Метод, выполняющий дополнительное изменение токена на создание файла перед тем, как объект файла будет создан.
Modified Дата и время последнего изменения файла.
ModifiedByID Идентификатор пользователя изменившего файл.
ModifiedByName Имя пользователя изменившего файл.
Name Имя файла или null, если имя не задано. Для значения null имя может быть автоматически определено по пути к файлу ContentPath.
Permissions Разрешения на редактирование файла или null, если будут использоваться разрешения по умолчанию. По умолчанию разрешения определяются источником файлов, но обычно это файл со всеми разрешениями.
Source Источник файлов, используемый для создания файла.
Type Тип файла или null, если тип файла не указан. Для значения null источник файлов может указать стандартный тип файла.
VersionTokenActionAsync Метод, выполняющий дополнительное изменение токена на создание версии файла перед тем, как объект версия будет создана.

Методы

AddWithNotificationAsync Создаёт файл, в случае успешного создания добавляет его в коллекцию с уведомлением источника о добавлении, а затем возвращает файл. При возникновении ошибок возвращает null, причём файл не добавляется в коллекцию. Вторым значением возвращает результат создания файла, который содержит описание возникших ошибок, если они возникли.
EqualsDetermines whether the specified object is equal to the current object.
(Унаследован от Object)
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.
(Унаследован от Object)
GetTypeGets the Type of the current instance.
(Унаследован от Object)
MemberwiseCloneCreates a shallow copy of the current Object.
(Унаследован от Object)
ReturnAsync Создаёт и возвращает файл. При возникновении ошибок возвращает null. Вторым значением возвращает результат создания файла, который содержит описание возникших ошибок, если они возникли.
SetAuthor Устанавливает автора файла, т.е. пользователя, создавшего файл. По умолчанию файл считается созданным текущим пользователем. Как правило, информация по автору файла используется только в объекте файла (например, в других расширениях или в UI), т.к. стандартное API игнорирует её и использует текущего пользователя в качестве автора при сохранении в БД.
SetCategory Устанавливает категорию файла. По умолчанию создаётся файл без категории.
SetContent(FuncCancellationToken, ValueTaskIFileContent)Устанавливает функцию, создающую контент для создаваемого файла.
SetContent(FuncIFileContent, CancellationToken, ValueTask)Устанавливает действие, выполняющее инициализацию контента создаваемого файла.
SetContent(Stream)Устанавливает контент файла посредством чтения данных из заданного потока.
SetContent(String) Устанавливает контент файла по полному пути к файлу на диске. Если у создаваемого файла не было задано имя, то оно будет определено как имя файла по заданному пути.
SetFileTokenУстанавливает метод, изменяющий токен на создание файла перед тем, как по нему будет создан файл.
SetModified Устанавливает дату и время последнего изменения файла, а также ID и имя автора этих изменений.
SetName Устанавливает имя файла. Имя файла можно не указывать, если контент файла определяется как путь к файлу на диске.
SetPermissions Устанавливает разрешения на файл. По умолчанию разрешения определяются источником файлов, но обычно это файл со всеми разрешениями.
SetSource Устанавливает заданный источник как используемый при создании файла. По умолчанию файл создаётся с источником, заданным при создании объекта.
SetType Устанавливает тип файла. По умолчанию тип может определяться источником файлов.
SetVersionTokenУстанавливает метод, изменяющий токен на создание версии файла перед тем, как по нему будет создана версия.
ToStringReturns a string that represents the current object.
(Унаследован от Object)

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

Get
(Определяется ComHelper)
InternalMarkerCanvas Возвращает маркер аннотации
(Определяется AnnotationInternalsAccessor)
Invoke
(Определяется ComHelper)
Set
(Определяется ComHelper)
SetCategory Устанавливает категорию файла в виде строки без указания идентификатора категории.
(Определяется FileExtensions)
SetCategory Устанавливает категорию файла в виде строки без указания идентификатора категории.
(Определяется FileExtensions)
SetContent Устанавливает содержимое создаваемого файла по заданному объекту контента IFileContent. Содержимое и размер создаваемого файла будут вычисляться на основании заданного объекта. Содержимое является нелокальным, т.е. не сохраняется во временную папку. Поэтому не используйте его на клиенте, если файл будет доступен пользователю в UI.
(Определяется FileExtensions)
SetContent Устанавливает содержимое создаваемого файла по заданному массиву байт.
(Определяется FileExtensions)
SetContent Устанавливает содержимое создаваемого файла по функции, возвращающей контент, и по функции, возвращающей его размер. Содержимое является нелокальным, т.е. не сохраняется во временную папку. Поэтому не используйте его на клиенте, если файл будет доступен пользователю в UI.
(Определяется FileExtensions)
SetContent Устанавливает содержимое создаваемого файла по функции, возвращающей контент, и по фиксированному (заранее вычисленному) размеру. Содержимое является нелокальным, т.е. не сохраняется во временную папку. Поэтому не используйте его на клиенте, если файл будет доступен пользователю в UI.
(Определяется FileExtensions)
SetContentReadOnly Устанавливает содержимое создаваемого файла на основании локального файла, который не копируется в папку с кэшем. Рекомендуется использовать этот способ, если файл создаётся только для чтения, например, для того, чтобы сохраниться на сервер. Содержимое является нелокальным, т.е. не сохраняется во временную папку. Поэтому не используйте его на клиенте, если файл будет доступен пользователю в UI.
(Определяется FileExtensions)
SetContentText Устанавливает содержимое создаваемого файла по заданному тексту с указанием кодировки.
(Определяется FileExtensions)

См. также