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

FileBuilder - класс

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

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

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

Конструкторы
  ИмяОписание
Открытый методFileBuilder
Создаёт экземпляр класса с указанием коллекции, в которую может быть добавлен файл с уведомлением об изменениях.
В начало страницы
Свойства
  ИмяОписание
Защищённое свойствоAuthor
Автор файла, т.е. пользователь, создавший файл, или null, если автором является текущий пользователь.
Защищённое свойствоCategory
Категория файла или null, если категория не указана.
Защищённое свойствоContentActionAsync
Метод, инициализирующий контент файла для способа создания контента Action.
Защищённое свойствоContentFactoryAsync
Функция, создающая контент файла для способа создания контента Factory.
Защищённое свойствоContentPath
Полный путь к контенту файла для способа создания контента Path.
Защищённое свойствоContentStream
Полный путь к потоку с контентом файла для способа создания контента Stream.
Защищённое свойствоContentType
Способ создания контента файла. По умолчанию значение Undefined запрещает создание файла.
Защищённое свойствоFiles
Коллекция, в которую может быть добавлен файл с уведомлением об изменениях.
Защищённое свойствоFileTokenActionAsync
Метод, выполняющий дополнительное изменение токена на создание файла перед тем, как объект файла будет создан.
Защищённое свойствоName
Имя файла или null, если имя не задано. Для значения null имя может быть автоматически определено по пути к файлу ContentPath.
Защищённое свойствоPermissions
Разрешения на редактирование файла или null, если будут использоваться разрешения по умолчанию. По умолчанию разрешения определяются источником файлов, но обычно это файл со всеми разрешениями.
Защищённое свойствоSource
Источник файлов, используемый для создания файла.
Защищённое свойствоType
Тип файла или null, если тип файла не указан. Для значения null источник файлов может указать стандартный тип файла.
Защищённое свойствоVersionTokenActionAsync
Метод, выполняющий дополнительное изменение токена на создание версии файла перед тем, как объект версия будет создана.
В начало страницы
Методы
  ИмяОписание
Открытый методAddWithNotificationAsync
Создаёт файл, в случае успешного создания добавляет его в коллекцию с уведомлением источника о добавлении, а затем возвращает файл. При возникновении ошибок возвращает null, причём файл не добавляется в коллекцию. Вторым значением возвращает результат создания файла, который содержит описание возникших ошибок, если они возникли.
Открытый метод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.)
Открытый методGetHashCode
Serves as the default hash function.
(Унаследован от Object.)
Открытый методGetType
Gets the Type of the current instance.
(Унаследован от Object.)
Защищённый методMemberwiseClone
Creates a shallow copy of the current Object.
(Унаследован от Object.)
Открытый методReturnAsync
Создаёт и возвращает файл. При возникновении ошибок возвращает null. Вторым значением возвращает результат создания файла, который содержит описание возникших ошибок, если они возникли.
Открытый методSetAuthor
Устанавливает автора файла, т.е. пользователя, создавшего файл. По умолчанию файл считается созданным текущим пользователем. Как правило, информация по автору файла используется только в объекте файла (например, в других расширениях или в UI), т.к. стандартное API игнорирует её и использует текущего пользователя в качестве автора при сохранении в БД.
Открытый методSetCategory
Устанавливает категорию файла. По умолчанию создаётся файл без категории.
Открытый методSetContent(Stream)
Устанавливает контент файла посредством чтения данных из заданного потока.
Открытый методSetContent(String)
Устанавливает контент файла по полному пути к файлу на диске. Если у создаваемого файла не было задано имя, то оно будет определено как имя файла по заданному пути.
Открытый методSetContent(FuncCancellationToken, ValueTaskIFileContent)
Устанавливает функцию, создающую контент для создаваемого файла.
Открытый методSetContent(FuncIFileContent, CancellationToken, ValueTask)
Устанавливает действие, выполняющее инициализацию контента создаваемого файла.
Открытый методSetFileToken
Устанавливает метод, изменяющий токен на создание файла перед тем, как по нему будет создан файл.
Открытый методSetName
Устанавливает имя файла. Имя файла можно не указывать, если контент файла определяется как путь к файлу на диске.
Открытый методSetPermissions
Устанавливает разрешения на файл. По умолчанию разрешения определяются источником файлов, но обычно это файл со всеми разрешениями.
Открытый методSetSource
Устанавливает заданный источник как используемый при создании файла. По умолчанию файл создаётся с источником, заданным при создании объекта.
Открытый методSetType
Устанавливает тип файла. По умолчанию тип может определяться источником файлов.
Открытый методSetVersionToken
Устанавливает метод, изменяющий токен на создание версии файла перед тем, как по нему будет создана версия.
Открытый методToString
Returns a string that represents the current object.
(Унаследован от Object.)
В начало страницы
Методы расширения
  ИмяОписание
Открытый метод расширенияGet (Определяется ComHelper.)
Открытый метод расширенияInternalMarkerCanvas
Возвращает маркер аннотации
(Определяется AnnotationInternalsAccessor.)
Открытый метод расширенияInvoke (Определяется ComHelper.)
Открытый метод расширенияSet (Определяется ComHelper.)
Открытый метод расширенияSetCategory(String)Перегружен.
Устанавливает категорию файла в виде строки без указания идентификатора категории.
(Определяется FileExtensions.)
Открытый метод расширенияSetCategory(String, Guid)Перегружен.
Устанавливает категорию файла в виде строки без указания идентификатора категории.
(Определяется FileExtensions.)
Открытый метод расширенияSetContent(IFileContent)Перегружен.
Устанавливает содержимое создаваемого файла по заданному объекту контента IFileContent. Содержимое и размер создаваемого файла будут вычисляться на основании заданного объекта. Содержимое является нелокальным, т.е. не сохраняется во временную папку. Поэтому не используйте его на клиенте, если файл будет доступен пользователю в UI.
(Определяется FileExtensions.)
Открытый метод расширенияSetContent(FuncCancellationToken, ValueTaskStream, FuncCancellationToken, ValueTaskInt64)Перегружен.
Устанавливает содержимое создаваемого файла по функции, возвращающей контент, и по функции, возвращающей его размер. Содержимое является нелокальным, т.е. не сохраняется во временную папку. Поэтому не используйте его на клиенте, если файл будет доступен пользователю в UI.
(Определяется FileExtensions.)
Открытый метод расширенияSetContent(FuncCancellationToken, ValueTaskStream, Int64)Перегружен.
Устанавливает содержимое создаваемого файла по функции, возвращающей контент, и по фиксированному (заранее вычисленному) размеру. Содержимое является нелокальным, т.е. не сохраняется во временную папку. Поэтому не используйте его на клиенте, если файл будет доступен пользователю в UI.
(Определяется FileExtensions.)
Открытый метод расширенияSetContent(Byte, Boolean)Перегружен.
Устанавливает содержимое создаваемого файла по заданному массиву байт.
(Определяется FileExtensions.)
Открытый метод расширенияSetContentReadOnly
Устанавливает содержимое создаваемого файла на основании локального файла, который не копируется в папку с кэшем. Рекомендуется использовать этот способ, если файл создаётся только для чтения, например, для того, чтобы сохраниться на сервер. Содержимое является нелокальным, т.е. не сохраняется во временную папку. Поэтому не используйте его на клиенте, если файл будет доступен пользователю в UI.
(Определяется FileExtensions.)
Открытый метод расширенияSetContentText
Устанавливает содержимое создаваемого файла по заданному тексту с указанием кодировки.
(Определяется FileExtensions.)
В начало страницы
Заметки
Классы-наследники могут переопределить значения его методов, а также добавить новые методы.
См. также