Bezpieczeństwo klasy

public sealed class Security  

Dziedziczenie

object ←
Security

Członkowie dziedziczeni

• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Przykłady

Przykład pokazuje, jak zaszyfrować dokument PDF.

// utwórz Security  
var plugin = new Security();  
// utwórz obiekt EncryptionOptions, aby ustawić instrukcje  
var opt = new EncryptionOptions("123456", "qwerty");  
// dodaj ścieżkę do pliku wejściowego  
opt.AddInput(new FileDataSource(inputPath));  
// ustaw ścieżkę do pliku wyjściowego  
opt.AddOutput(new FileDataSource(outputPath));  
// wykonaj proces  
plugin.Process(opt);  

Przykład pokazuje, jak odszyfrować dokument PDF.

// utwórz Security  
var plugin = new Security();  
// utwórz obiekt DecryptionOptions, aby ustawić instrukcje  
var opt = new DecryptionOptions("123456"));  
// dodaj ścieżkę do pliku wejściowego  
opt.AddInput(new FileDataSource(inputPath));  
// ustaw ścieżkę do pliku wyjściowego  
opt.AddOutput(new FileDataSource(outputPath));  
// wykonaj proces  
plugin.Process(opt);  

Konstruktory

Security()

public Security()  

Metody

Process(IPluginOptions)

Rozpoczyna przetwarzanie Documentize.Security z określonymi parametrami.

public ResultContainer Process(IPluginOptions options)  

Parametry

• options IPluginOptions: Obiekt opcji zawierający instrukcje dla Documentize.Security.

Zwraca

ResultContainer : Obiekt ResultContainer zawierający wynik operacji.

Wyjątki

InvalidOperationException

Dzielnik klas

public class Splitter

Dziedziczenie

obiekt ← Dzielnik

Członkowie dziedziczeni

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Przykłady

Przykład demonstruje, jak podzielić dokument PDF.

// utwórz Dzielnik
var plugin = new Splitter();
// utwórz obiekt SplitOptions, aby ustawić instrukcje
var opt = new SplitOptions();
// dodaj ścieżkę pliku wejściowego
opt.AddInput(new FileDataSource(inputPath));
// ustaw ścieżki plików wyjściowych
opt.AddOutput(new FileDataSource(outputPath1));
opt.AddOutput(new FileDataSource(outputPath2));
// wykonaj proces
plugin.Process(opt);

Konstruktory

Splitter()

public Splitter()

Metody

Process(IPluginOptions)

Rozpoczyna przetwarzanie Documentize.Splitter z określonymi parametrami.

public ResultContainer Process(IPluginOptions options)

Parametry

• options IPluginOptions: Obiekt opcji zawierający instrukcje dla Documentize.Splitter.

Zwraca

ResultContainer : Obiekt ResultContainer zawierający wynik operacji.

Wyjątki

InvalidOperationException

Enum ConvertErrorAction

public enum ConvertErrorAction  

Fields

• Delete = 0
• None = 1

Enum ConvertSoftMaskAction

public enum ConvertSoftMaskAction  

Fields

• ConvertToStencilMask = 1: Miękka maska zostanie skonwertowana na maskę szablonową.
• Default = 0: Użyj domyślnej strategii.

Enum HtmlMediaType

public enum HtmlMediaType

Fields

• Print = 0: Drukuj.
• Screen = 1: Ekran.

Enum HtmlPageLayoutOption

public enum HtmlPageLayoutOption  

Fields

• FitToWidestContentWidth = 3: Wskazuje, że szerokość strony jest determinowana przez sam rozmiar treści, a nie przez określoną szerokość strony.
• None = 0: Wartość domyślna, która wskazuje, że HtmlPageLayoutOption nie wpłynie na rozmiary i układy stron.
• ScaleToPageWidth = 256: Wskazuje, że treść dokumentu zostanie skalowana, aby dopasować się do strony.

Enum PdfAStandardVersion

public enum PdfAStandardVersion

Fields

• Auto = 0: Wersja standardu PDF/A jest ustalana automatycznie.
• PDF_A_1A = 1: Określa wersję standardu PDF/A-1a.
• PDF_A_1B = 2: Określa wersję standardu PDF/A-1b.
• PDF_A_2A = 3: Określa wersję standardu PDF/A-2a.
• PDF_A_2B = 4: Określa wersję standardu PDF/A-2b.
• PDF_A_2U = 5: Określa wersję standardu PDF/A-2u.
• PDF_A_3A = 6: Określa wersję standardu PDF/A-3a.
• PDF_A_3B = 7: Określa wersję standardu PDF/A-3b.
• PDF_A_3U = 8: Określa wersję standardu PDF/A-3u.

Enum PdfToHtmlOptions.SaveDataType

public enum PdfToHtmlOptions.SaveDataType  

Pola

• FileWithEmbeddedResources = 1: Zapisz HTML do pliku z osadzonymi zasobami
• FileWithExternalResources = 0: Zapisz HTML do pliku z zewnętrznymi zasobami
• StreamWithEmbeddedResources = 2: Zapisz HTML do strumienia pliku z osadzonymi zasobami

Enum PdfToXlsOptions.ExcelFormat

Pozwala na określenie formatu pliku .xlsx, .xls/xml lub csv.
Wartość domyślna to XLSX.

public enum PdfToXlsOptions.ExcelFormat  

Fields

• CSV = 2: Format pliku wartości oddzielonych przecinkami (CSV).
• ODS = 4: Arkusz kalkulacyjny Open Document.
• XLSM = 3: Format pliku Office Open XML (.xlsm) z włączonymi makrami.
• XLSX = 1: Format pliku Office Open XML (.xlsx).
• XMLSpreadSheet2003 = 0: Format pliku Excel 2003 XML (.xls).

Enum TextExtractorOptions.TextFormattingMode

public enum TextExtractorOptions.TextFormattingMode

Fields

• Plain = 2: Reprezentuje zawartość tekstową PDF, uwzględniając względne położenie fragmentów tekstu, ale bez dodawania dodatkowych spacji.
• Pure = 0: Reprezentuje zawartość tekstową PDF z kilkoma rutynami formatowania. Obejmuje to uwzględnianie względnych pozycji i dodawanie dodatkowych spacji w celu wyrównania tekstu do szerokości strony.
• Raw = 1: Reprezentuje zawartość PDF w stanie niezmienionym, tzn. bez formatowania.

GeneratorTabeli Klasa

public sealed class TableGenerator

Dziedziczenie

object ← TableGenerator

Członkowie dziedziczeni

• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Przykłady

Przykład pokazuje, jak dodać tabelę do pliku PDF.

// utwórz GeneratorTabeli
var plugin = new TableGenerator();
// utwórz obiekt TableOptions, aby ustawić instrukcje
TableOptions opt = new TableOptions().InsertPageBefore(1)
   .AddTable()
        .AddRow()
            .AddCell().AddParagraph("Nazwisko")
            .AddCell().AddParagraph("Wiek")
        .AddRow()
            .AddCell().AddParagraph("Bob")
            .AddCell().AddParagraph("12")
        .AddRow()
            .AddCell().AddParagraph("Sam")
            .AddCell().AddParagraph("20")
        .AddRow()
            .AddCell().AddParagraph("Sandy")
            .AddCell().AddParagraph("26")
        .AddRow()
            .AddCell().AddParagraph("Tom")
            .AddCell().AddParagraph("12")
        .AddRow()
            .AddCell().AddParagraph("Jim")
            .AddCell().AddParagraph("27");
// dodaj ścieżkę do pliku wejściowego
opt.AddInput(new FileDataSource(inputPath1));
// ustaw ścieżkę do pliku wyjściowego
opt.AddOutput(new FileDataSource(outputPath));
// wykonaj proces
plugin.Process(opt);

Konstruktory

TableGenerator()

public TableGenerator()

Metody

Process(TableOptions)

Rozpoczyna przetwarzanie Documentize.TableGenerator z określonymi parametrami.

public ResultContainer Process(TableOptions options)

Parametry

• options TableOptions: Obiekt opcji zawierający instrukcje dla Documentize.TableGenerator.

Zwraca

ResultContainer : Obiekt ResultContainer zawierający wynik operacji.

Informacja o stronie klasy

public class PageInfo : PageSize  

Dziedziczenie

object ←
PageSize ←
PageInfo

Członkowie dziedziczeni

• PageSize.Width,
• PageSize.Height,
• PageSize.IsLandscape,
• PageSize.A0,
• PageSize.A1,
• PageSize.A2,
• PageSize.A3,
• PageSize.A4,
• PageSize.A5,
• PageSize.A6,
• PageSize.B5,
• PageSize.PageLetter,
• PageSize.PageLegal,
• PageSize.PageLedger,
• PageSize.P11x17,
• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Konstruktorzy

PageInfo()

Konstruktor Documentize.PageInfo.

public PageInfo()  

PageInfo(double, double)

Konstruktor Documentize.PageInfo.

public PageInfo(double width, double height)  

Parametry

• width double: Szerokość strony.
• height double: Wysokość strony.

Właściwości

MarginBottom

Pobiera lub ustawia wartość wskazującą dolny margines.

public double MarginBottom { get; set; }  

Wartość właściwości

double

MarginLeft

Pobiera lub ustawia wartość wskazującą lewy margines.

public double MarginLeft { get; set; }  

Wartość właściwości

double

MarginRight

Pobiera lub ustawia wartość wskazującą prawy margines.

public double MarginRight { get; set; }  

Wartość właściwości

double

MarginTop

Pobiera lub ustawia wartość wskazującą górny margines.

public double MarginTop { get; set; }  

Wartość właściwości

double

Informacje o klasie

public static class Info  

Dziedziczenie

object ←
Info

Członkowie dziedziczeni

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Pola

• AssemblyVersion Wersja zestawu.

public const string AssemblyVersion = “24.12.0”

Wartość pola

string

Produkt

Nazwa produktu.

public const string Product = "Documentize"  

Wartość pola

string

Interfejs IDataSource

public interface IDataSource

Właściwości

TypDanych

Typ źródła danych.

DataType DataType { get; }

Wartość Właściwości

TypDanych

Interfejs IOperationResult

public interface IOperationResult  

Właściwości

Data

Zwraca surowe dane.

object Data { get; }  

Wartość właściwości

object

IsFile

Wskazuje, czy wynik jest ścieżką do pliku wyjściowego.

bool IsFile { get; }  

Wartość właściwości

bool

IsStream

Wskazuje, czy wynik jest strumieniem wyjściowym.

bool IsStream { get; }  

Wartość właściwości

bool

IsString

Wskazuje, czy wynik jest łańcuchem tekstowym.

bool IsString { get; }  

Wartość właściwości

bool

Metody

ToFile()

Próbuje przekonwertować wynik na plik.

string ToFile()  

Zwraca

string : Łańcuch reprezentujący ścieżkę do pliku wyjściowego, jeśli wynik jest plikiem; w przeciwnym razie null.

ToStream()

Próbuje przekonwertować wynik na obiekt strumienia.

Stream ToStream()  

Zwraca

Stream : Obiekt strumienia reprezentujący dane wyjściowe, jeśli wynik jest strumieniem; w przeciwnym razie null.

Interfejs IPluginOptions

public interface IPluginOptions

Katalog źródeł danych klasy

public sealed class DirectoryDataSource : IDataSource

Dziedziczenie

object ← DirectoryDataSource

Implementuje

• IDataSource

Czlonek dziedziczony

• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Konstruktory

DirectoryDataSource(string)

Inicjalizuje nowe dane katalogowe z określoną ścieżką.

public DirectoryDataSource(string path)

Parametry

• path string: Ciąg znaków reprezentujący ścieżkę do katalogu.

Właściwości

DataType

Typ źródła danych.

public DataType DataType { get; }

Wartość właściwości

DataType

Path

Pobiera ścieżkę do katalogu bieżących danych.

public string Path { get; }

Wartość właściwości

string

Klasa AddTimestampOptions

public class AddTimestampOptions : PluginBaseOptions, IPluginOptions  

Dziedziczenie

object ←
PluginBaseOptions ←
AddTimestampOptions

Implementuje

• IPluginOptions

Dziedziczone członkowie

• PluginBaseOptions.AddInput(IDataSource),
• PluginBaseOptions.AddOutput(IDataSource),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Konstruktorzy

AddTimestampOptions(Stream, string, string, string)

Inicjalizuje nową instancję obiektu Documentize.AddTimestampOptions z domyślnymi opcjami.

public AddTimestampOptions(Stream pfx, string password, string serverUrl, string serverBasicAuthCredentials = "")  

Parametry

• pfx Stream: Ścieżka do pliku pfx.
• password string: Hasło do pliku pfx.
• serverUrl string: Adres URL serwera znaczników czasowych.
• serverBasicAuthCredentials string: Dane uwierzytelniające podstawowej autoryzacji, nazwa użytkownika i hasło są łączone w ciąg “nazwa_użytkownika:hasło”. (Opcjonalnie).

AddTimestampOptions(string, string, string, string)

Inicjalizuje nową instancję obiektu Documentize.AddTimestampOptions z domyślnymi opcjami.

public AddTimestampOptions(string pfx, string password, string serverUrl, string serverBasicAuthCredentials = "")  

Parametry

• pfx string: Ścieżka do pliku pfx.
• password string: Hasło do pliku pfx.
• serverUrl string: Adres URL serwera znaczników czasowych.
• serverBasicAuthCredentials string: Dane uwierzytelniające podstawowej autoryzacji, nazwa użytkownika i hasło są łączone w ciąg “nazwa_użytkownika:hasło”. (Opcjonalnie).

Klasa CompressOptions

public sealed class CompressOptions : PluginBaseOptions, IPluginOptions  

Dziedziczenie

object ←
PluginBaseOptions ←
CompressOptions

Implementuje

• IPluginOptions

Członkowie dziedziczeni

• PluginBaseOptions.AddInput(IDataSource),
• PluginBaseOptions.AddOutput(IDataSource),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Konstruktorzy

CompressOptions()

Inicjalizuje nową instancję obiektu Documentize.CompressOptions z domyślnymi opcjami.

public CompressOptions()  

Klasa DecryptionOptions

public class DecryptionOptions : PluginBaseOptions, IPluginOptions  

Dziedziczenie

object ←
PluginBaseOptions ←
DecryptionOptions

Implementuje

• IPluginOptions

Członkowie dziedziczeni

• PluginBaseOptions.AddInput(IDataSource),
• PluginBaseOptions.AddOutput(IDataSource),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Konstruktory

DecryptionOptions(string)

Inicjalizuje nową instancję obiektu Documentize.DecryptionOptions z domyślnymi opcjami.

public DecryptionOptions(string ownerPassword)  

Parametry

• ownerPassword string: Hasło właściciela.

Właściwości

OwnerPassword

Hasło właściciela.

public string OwnerPassword { get; set; }  

Wartość właściwości

string

Klasa DocConverter

public sealed class DocConverter

Dziedziczenie

object ← DocConverter

Członkowie dziedziczeni

• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Przykłady

Przykład pokazuje, jak skonwertować dokument PDF na format Doc.

// utwórz DocConverter
var plugin = new DocConverter();
// utwórz obiekt PdfToDocOptions, aby ustawić instrukcje
var opt = new PdfToDocOptions();
// dodaj ścieżkę pliku wejściowego
opt.AddInput(new FileDataSource(inputPath));
// ustaw ścieżkę pliku wyjściowego
opt.AddOutput(new FileDataSource(outputPath));
// wykonaj proces
plugin.Process(opt);

Konstruktory

DocConverter()

public DocConverter()

Metody

Dispose()

Implementacja IDisposable.

public void Dispose()

Process(PdfToDocOptions)

Rozpoczyna przetwarzanie Documentize.DocConverter z określonymi parametrami.

public ResultContainer Process(PdfToDocOptions options)

Parametry

• options PdfToDocOptions: Obiekt opcji zawierający instrukcje dla Documentize.DocConverter.

Zwraca

ResultContainer : Obiekt Documentize.ResultContainer zawierający wynik operacji.

Klasa EncryptionOptions

public class EncryptionOptions : PluginBaseOptions, IPluginOptions

Dziedziczenie

obiekt ← PluginBaseOptions ← EncryptionOptions

Implementuje

• IPluginOptions

Członkowie dziedziczeni

• PluginBaseOptions.AddInput(IDataSource),
• PluginBaseOptions.AddOutput(IDataSource),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• obiekt.GetType(),
• obiekt.MemberwiseClone(),
• obiekt.ToString(),
• obiekt.Equals(obiekt?),
• obiekt.Equals(obiekt?, obiekt?),
• obiekt.ReferenceEquals(obiekt?, obiekt?),
• obiekt.GetHashCode()

Konstruktorzy

EncryptionOptions(string, string)

Inicjalizuje nową instancję obiektu Documentize.EncryptionOptions z domyślnymi opcjami.

public EncryptionOptions(string ownerPassword, string userPassword)

Parametry

• ownerPassword string: Hasło właściciela.
• userPassword string: Hasło użytkownika.

Właściwości

OwnerPassword

Hasło właściciela.

public string OwnerPassword { get; set; }

Wartość właściwości

string

UserPassword

Hasło użytkownika.

public string UserPassword { get; set; }

Wartość właściwości

string

Klasa FileDataSource

public sealed class FileDataSource : IDataSource

Dziedziczenie

object ← FileDataSource

Implementuje

• IDataSource

Członkowie dziedziczeni

• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Konstruktory

FileDataSource(string)

Inicjalizuje nowe źródło danych plikowych ze wskazaną ścieżką.

public FileDataSource(string path)

Parametry

• path string: Ciąg reprezentujący ścieżkę do pliku źródłowego.

Właściwości

DataType

Typ źródła danych.

public DataType DataType { get; }

Wartość Właściwości

DataType

Path

Pobiera ścieżkę do pliku bieżących danych.

public string Path { get; }

Wartość Właściwości

string

Klasa FileResult

public sealed class FileResult : IOperationResult

Dziedziczenie

object ← FileResult

Implementuje

• IOperationResult

Członkowie Dziedziczeni

• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Właściwości

Data

Uzyskuje surowe dane.

public object Data { get; }

Wartość właściwości

object

IsFile

Wskazuje, czy wynik jest ścieżką do pliku wyjściowego.

public bool IsFile { get; }

Wartość właściwości

bool

IsStream

Wskazuje, czy wynik jest strumieniem wyjściowym.

public bool IsStream { get; }

Wartość właściwości

bool

IsString

Wskazuje, czy wynik jest ciągiem tekstowym.

public bool IsString { get; }

Wartość właściwości

bool

Metody

ToFile()

Próbuje przekonwertować wynik na plik.

public string ToFile()

Zwraca

string : Ciąg reprezentujący ścieżkę do pliku wyjściowego, jeśli wynik jest plikiem; w przeciwnym razie null.

ToStream()

Próbuje przekonwertować wynik na obiekt strumienia.

public Stream ToStream()

Zwraca

Stream : Obiekt strumienia reprezentujący dane wyjściowe, jeśli wynik jest strumieniem; w przeciwnym razie null.

Klasa HtmlConverter

public sealed class HtmlConverter : IDisposable

Dziedziczenie

object ← HtmlConverter

Implementuje

• IDisposable

Członkowie dziedziczeni

• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Przykłady

Ten przykład demonstruje, jak konwertować PDF na dokument HTML.

// utwórz HtmlConverter
var plugin = new HtmlConverter();
// utwórz obiekt PdfToHtmlOptions, aby ustawić typ danych wyjściowych jako plik z osadzonymi zasobami
var opt = new PdfToHtmlOptions(PdfToHtmlOptions.SaveDataType.FileWithEmbeddedResources);
// dodaj ścieżkę pliku wejściowego
opt.AddInput(new FileDataSource(inputPath));
// ustaw ścieżkę pliku wyjściowego
opt.AddOutput(new FileDataSource(outputPath));
plugin.Process(opt);

Ten przykład demonstruje, jak konwertować HTML na dokument PDF.

// utwórz HtmlConverter
var plugin = new HtmlConverter();
// utwórz HtmlToPdfOptions
var opt = new HtmlToPdfOptions();
// dodaj ścieżkę pliku wejściowego
opt.AddInput(new FileDataSource(inputPath));
// ustaw ścieżkę pliku wyjściowego
opt.AddOutput(new FileDataSource(outputPath));
plugin.Process(opt);

Konstruktory

HtmlConverter()

public HtmlConverter()

Metody

Dispose()

Implementacja IDisposable.

public void Dispose()

Process(IPluginOptions)

Rozpoczyna przetwarzanie Documentize.HtmlConverter z określonymi parametrami.

public ResultContainer Process(IPluginOptions options)

Parametry

• options IPluginOptions: Obiekt opcji zawierający instrukcje dla Documentize.HtmlConverter.

Zwraca

ResultContainer : Obiekt Documentize.ResultContainer zawierający wynik operacji.

Klasa HtmlToPdfOptions

public sealed class HtmlToPdfOptions : PluginBaseOptions, IPluginOptions

Dziedziczenie

object ← PluginBaseOptions ← HtmlToPdfOptions

Implementuje

• IPluginOptions

Dziedziczone Członkowie

• PluginBaseOptions.AddInput(IDataSource),
• PluginBaseOptions.AddOutput(IDataSource),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Konstruktory

HtmlToPdfOptions()

Inicjalizuje nową instancję obiektu Documentize.HtmlToPdfOptions.

public HtmlToPdfOptions()

Właściwości

BasePath

Podstawowa ścieżka/URL dla pliku HTML.

public string BasePath { get; set; }

Wartość Właściwości

string

HtmlMediaType

Pobiera lub ustawia możliwe typy mediów używane podczas renderowania.

public HtmlMediaType HtmlMediaType { get; set; }

Wartość Właściwości

HtmlMediaType

IsRenderToSinglePage

Pobiera lub ustawia renderowanie całego dokumentu na pojedynczej stronie.

public bool IsRenderToSinglePage { get; set; }

Wartość Właściwości

bool

PageInfo

Pobiera lub ustawia informacje o stronie dokumentu.

public PageInfo PageInfo { get; set; }

Wartość Właściwości

PageInfo

PageLayoutOption

Pobiera lub ustawia opcję układu.

public HtmlPageLayoutOption PageLayoutOption { get; set; }

Wartość Właściwości

HtmlPageLayoutOption

Klasa ImageExtractor

public class ImageExtractor : PdfExtractor, IDisposable

Dziedziczenie

object ← PdfExtractor ← ImageExtractor

Implementuje

• IDisposable

Członkowie dziedziczeni

• PdfExtractor.Process(IPluginOptions),
• PdfExtractor.Dispose(),
• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Przykłady

Przykład demonstruje, jak wyodrębnić obrazy z dokumentu PDF.

// utwórz obiekt ImageExtractor do wyodrębniania obrazów
using (var plugin = new ImageExtractor())
{
    // utwórz ImageExtractorOptions
    var opt = new ImageExtractorOptions();

    // dodaj ścieżkę pliku wejściowego
    opt.AddInput(new FileDataSource(inputPath));
    // ustaw katalog wyjściowy
    opt.AddInput(new FileDataSource("D:\\"));

    // wykonaj proces wyodrębniania
    var resultContainer = plugin.Process(opt);

    // uzyskaj obraz z obiektu ResultContainer
    var imageExtracted = resultContainer.ResultCollection[0].ToFile();
}

Konstruktory

ImageExtractor()

public ImageExtractor()

Klasa ImageExtractorOptions

public sealed class ImageExtractorOptions : PdfExtractorOptions, IPluginOptions  

Dziedziczenie

object ←
PdfExtractorOptions ←
ImageExtractorOptions

Implementuje

• IPluginOptions

Dziedziczone członkowie

• PdfExtractorOptions.AddInput(IDataSource),
• PdfExtractorOptions.Inputs,
• PdfExtractorOptions.OperationName,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Uwagi

Dziedziczy funkcje dodawania danych (plików, strumieni) reprezentujących dokumenty PDF wejściowe.

Konstruktorzy

ImageExtractorOptions()

Inicjalizuje nową instancję obiektu Documentize.ImageExtractorOptions.

public ImageExtractorOptions()  

Właściwości

OperationName

Zwraca nazwę operacji.

public override string OperationName { get; }  

Wartość właściwości

string

Klasa JpegConverter

public sealed class JpegConverter

Dziedziczenie

object ← JpegConverter

Członkowie dziedziczeni

• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Przykłady

Przykład ilustruje, jak skonwertować dokument PDF na format JPEG.

// utworzyć JpegConverter
var plugin = new JpegConverter();
// utworzyć obiekt PdfToJpegOptions, aby ustawić instrukcje
var opt = new PdfToJpegOptions();
// dodać ścieżkę do pliku wejściowego
opt.AddInput(new FileDataSource(inputPath));
// ustawić ścieżkę do pliku wyjściowego
opt.AddOutput(new DirectoryDataSource(outputPath));
// przeprowadzić proces
plugin.Process(opt);

Konstruktory

JpegConverter()

public JpegConverter()

Metody

Process(PdfToJpegOptions)

Rozpoczyna przetwarzanie Documentize.JpegConverter z określonymi parametrami.

public ResultContainer Process(PdfToJpegOptions options)

Parametry

• options PdfToJpegOptions: Obiekt opcji zawierający instrukcje dla Documentize.JpegConverter.

Zwraca

ResultContainer : Obiekt ResultContainer zawierający wynik operacji.

Klasa MergeOptions

public sealed class MergeOptions : PluginBaseOptions, IPluginOptions

Dziedziczenie

object ← PluginBaseOptions ← MergeOptions

Implementuje

• IPluginOptions

Członkowie dziedziczeni

• PluginBaseOptions.AddInput(IDataSource),
• PluginBaseOptions.AddOutput(IDataSource),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Konstruktorzy

MergeOptions()

Inicjalizuje nową instancję obiektu Documentize.MergeOptions z domyślnymi opcjami.

public MergeOptions()

Klasa ObjectResult

public sealed class ObjectResult : IOperationResult

Dziedziczenie

object ← ObjectResult

Implementuje

• IOperationResult

Członkowie dziedziczeni

• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Właściwości

Dane

Zwraca surowe dane.

public object Data { get; }

Wartość właściwości

object

IsFile

Określa, czy wynik jest ścieżką do pliku wyjściowego.

public bool IsFile { get; }

Wartość właściwości

bool

IsObject

Określa, czy wynik jest obiektem.

public bool IsObject { get; }

Wartość właściwości

bool

IsStream

Określa, czy wynik jest ścieżką do pliku wyjściowego.

public bool IsStream { get; }

Wartość właściwości

bool

IsString

Określa, czy wynik jest ciągiem.

public bool IsString { get; }

Wartość właściwości

bool

Tekst

Zwraca tekstową reprezentację wyniku.

public string Text { get; }

Wartość właściwości

string

Metody

ToFile()

Próbuje przekonwertować wynik na plik.

public string ToFile()

Zwraca

string : Ciąg reprezentujący ścieżkę do pliku wyjściowego, jeśli wynik jest plikiem; w przeciwnym razie null.

ToStream()

Próbuje przekonwertować wynik na obiekt stream.

public Stream ToStream()

Zwraca

Stream : Obiekt stream reprezentujący dane wyjściowe, jeśli wynik jest strumieniem; w przeciwnym razie null.

ToString()

Próbuje przekonwertować wynik na ciąg.

public override string ToString()

Zwraca

string : Ciąg reprezentujący treść tekstową, jeśli wynik jest ciągiem; w przeciwnym razie zwraca base.ToString().

Klasa OptimizeOptions

public sealed class OptimizeOptions : PluginBaseOptions, IPluginOptions  

Dziedziczenie

object ←
PluginBaseOptions ←
OptimizeOptions

Implementuje

• IPluginOptions

Członkowie dziedziczeni

• PluginBaseOptions.AddInput(IDataSource),
• PluginBaseOptions.AddOutput(IDataSource),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Konstruktorzy

OptimizeOptions()

Inicjalizuje nową instancję obiektu Documentize.OptimizeOptions z domyślnymi opcjami.
Zlinearizuj dokument w celu

• jak najszybszego otwarcia pierwszej strony;
• jak najszybszego wyświetlenia następnej strony lub podążania za linkiem do następnej strony;
• wyświetlenia strony inkrementalnie w miarę jej przybywania, gdy dane dla strony są dostarczane przez wolny kanał (wyświetl najpierw najbardziej użyteczne dane);
• umożliwienia interakcji użytkownika, takiej jak podążanie za linkiem, jeszcze przed pełnym odebraniem i wyświetleniem całej strony.

public OptimizeOptions()  

Klasa PageSize

public class PageSize

Dziedziczenie

object ← PageSize

Pochodne

• PageInfo

Członkowie dziedziczeni

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Konstruktorzy

PageSize()

Konstruktor Documentize.PageSize. Domyślnie o rozmiarze A4.

public PageSize()

PageSize(double, double)

Konstruktor Documentize.PageSize.

public PageSize(double width, double height)

Parametry

• width double: Szerokość strony.
• height double: Wysokość strony.

Właściwości

A0

Rozmiar A0 (1189x840 mm).

public static PageSize A0 { get; }

Wartość Właściwości

PageSize

A1

Rozmiar A1 (840x594 mm).

public static PageSize A1 { get; }

Wartość Właściwości

PageSize

A2

Rozmiar A2 (594x420 mm).

public static PageSize A2 { get; }

Wartość Właściwości

PageSize

A3

Rozmiar A3 (420x297 mm).

public static PageSize A3 { get; }

Wartość Właściwości

PageSize

A4

Rozmiar A4 (297x210 mm).

public static PageSize A4 { get; }

Wartość Właściwości

PageSize

A5

Rozmiar A5 (210x148 mm).

public static PageSize A5 { get; }

Wartość Właściwości

PageSize

A6

Rozmiar A6 (148x105 mm).

public static PageSize A6 { get; }

Wartość Właściwości

PageSize

B5

Rozmiar B5 (250x176 mm).

public static PageSize B5 { get; }

Wartość Właściwości

PageSize

Height

Pobiera lub ustawia wysokość strony.

public double Height { get; set; }

Wartość Właściwości

double

IsLandscape

Pobiera orientację strony. Zwraca true, jeśli jest to orientacja pozioma, i false, jeśli jest to orientacja pionowa.

public bool IsLandscape { get; }

Wartość Właściwości

bool

P11x17

Format 11x17 cali.

public static PageSize P11x17 { get; }

Wartość Właściwości

PageSize

PageLedger

Rozmiar ledger (432x279 mm).

public static PageSize PageLedger { get; }

Wartość Właściwości

PageSize

PageLegal

Rozmiar legal (356x216 mm).

public static PageSize PageLegal { get; }

Wartość Właściwości

PageSize

PageLetter

Rozmiar letter (279x216 mm).

public static PageSize PageLetter { get; }

Wartość Właściwości

PageSize

Width

Pobiera lub ustawia szerokość strony.

public double Width { get; set; }

Wartość Właściwości

double

Klasa PdfAConverter

public sealed class PdfAConverter

Dziedziczenie

object ← PdfAConverter

Członkowie dziedziczeni

• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Przykłady

Przykład pokazuje, jak zweryfikować zgodność dokumentu PDF z formatem PDF/A (PDF/A-1a w tym przypadku):

// Utwórz klasę opcji, aby skonfigurować proces walidacji
var options = new PdfAValidateOptions
{
    PdfAVersion = PdfAStandardVersion.PDF_A_1A
};

// Dodaj jeden lub więcej plików do weryfikacji
options.AddInput(new FileDataSource("path_to_your_first_pdf_file.pdf")); // zamień na ścieżkę do swojego pliku
options.AddInput(new FileDataSource("path_to_your_second_pdf_file.pdf"));
// dodaj więcej plików w razie potrzeby

// Utwórz instancję wtyczki
var plugin = new PdfAConverter();

// Uruchom walidację i uzyskaj wyniki
var resultContainer = plugin.Process(options);

// Sprawdź właściwość resultContainer.ResultCollection, aby uzyskać wyniki walidacji dla każdego pliku:
for (var i = 0; i < resultContainer.ResultCollection.Count; i++)
{
    var result = resultContainer.ResultCollection[i];
    var validationResult = (PdfAValidationResult) result.Data;
    var isValid = validationResult.IsValid; // Wynik walidacji dla i-tego dokumentu
}

Przykład pokazuje, jak przekonwertować dokument PDF do formatu PDF/A (PDF/A-3b w tym przypadku):

// Utwórz klasę opcji, aby skonfigurować proces konwersji
var options = new PdfAConvertOptions
{
    PdfAVersion = PdfAStandardVersion.PDF_A_3B
};

// Dodaj plik źródłowy
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf")); // zamień na ścieżkę do swojego pliku

// Dodaj ścieżkę, aby zapisać przekonwertowany plik
options.AddOutput(new FileDataSource("path_to_the_converted_file.pdf"));

// Utwórz instancję wtyczki
var plugin = new PdfAConverter();

// Uruchom konwersję
plugin.Process(options);

Konstruktory

PdfAConverter()

public PdfAConverter()

Metody

Process(IPluginOptions)

Rozpoczyna proces konwersji lub walidacji PDF/A z danymi opcjami.

public ResultContainer Process(IPluginOptions options)

Parametry

• options IPluginOptions: Obiekt opcji zawierający instrukcje dla wtyczki. Musi być instancją klasy Documentize.PdfAConvertOptions lub Documentize.PdfAValidateOptions.

Zwraca

ResultContainer : Obiekt Documentize.ResultContainer zawierający wynik przetwarzania.

Klasa PdfAOptionsBase

Reprezentuje klasę bazową dla opcji wtyczki Documentize.PdfAConverter. Ta klasa zapewnia właściwości i metody do konfigurowania procesu konwersji i walidacji PDF/A.

public abstract class PdfAOptionsBase : IPluginOptions

Dziedziczenie

object ← PdfAOptionsBase

Pochodne

• PdfAConvertOptions,
• PdfAValidateOptions

Implementuje

• IPluginOptions

Członkowie dziedziczeni

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Konstruktorzy

PdfAOptionsBase()

protected PdfAOptionsBase()

Właściwości

AlignText

Uzyskuje lub ustawia wartość wskazującą, czy dodatkowe środki są konieczne, aby zachować wyrównanie tekstu podczas procesu konwersji PDF/A.

public bool AlignText { get; set; }

Wartość właściwości

bool

Uwagi

Gdy jest ustawione na true, proces konwersji będzie próbował przywrócić oryginalne granice segmentu tekstowego. Dla większości dokumentów nie ma potrzeby zmiany tej właściwości z domyślnej wartości false, ponieważ wyrównanie tekstu nie zmienia się podczas domyślnego procesu konwersji.

CheckDifferentNamesInFontDictionaries

Uzyskuje flagi, które kontrolują konwersję PDF/A dla przypadków, gdy źródłowy dokument PDF nie zgadza się ze specyfikacją PDF.

public bool CheckDifferentNamesInFontDictionaries { get; set; }

Wartość właściwości

bool

ErrorAction

Uzyskuje lub ustawia akcję, która ma być podjęta dla obiektów, które nie mogą być konwertowane.

public ConvertErrorAction ErrorAction { get; set; }

Wartość właściwości

ConvertErrorAction

IccProfileFileName

Uzyskuje lub ustawia nazwę pliku profilu ICC (International Color Consortium), który ma być użyty do konwersji PDF/A zamiast domyślnego.

public string IccProfileFileName { get; set; }

Wartość właściwości

string

Inputs

Uzyskuje kolekcję źródeł danych

public List<idatasource> Inputs { get; }

Wartość właściwości

List<IDataSource&gt;

IsLowMemoryMode

Uzyskuje lub ustawia wartość wskazującą, czy tryb niskiej pamięci jest włączony podczas procesu konwersji PDF/A.

public bool IsLowMemoryMode { get; set; }

Wartość właściwości

bool

LogOutputSource

Uzyskuje lub ustawia źródło danych dla logów.

public IDataSource LogOutputSource { get; set; }

Wartość właściwości

IDataSource

OptimizeFileSize

Uzyskuje lub ustawia wartość wskazującą, czy spróbować zmniejszyć rozmiar pliku podczas procesu konwersji PDF/A.

public bool OptimizeFileSize { get; set; }

Wartość właściwości

bool

Uwagi

Gdy jest ustawione na true, proces konwersji będzie próbował zmniejszyć rozmiar pliku. Może to wpłynąć na wydajność procesu konwersji.

PdfAVersion

Uzyskuje lub ustawia wersję standardu PDF/A, która ma być użyta do walidacji lub konwersji.

public PdfAStandardVersion PdfAVersion { get; set; }

Wartość właściwości

PdfAStandardVersion

Uwagi

Wersja standardu PDF/A jest używana do określenia poziomu zgodności dla walidacji i konwersji PDF/A. Jeśli wersja jest ustawiona na Documentize.PdfAStandardVersion.Auto, system automatycznie określi odpowiednią wersję standardu PDF/A do walidacji na podstawie metadanych dokumentu. Dla procesu konwersji PDF/A, Documentize.PdfAStandardVersion.Auto domyślnie jest ustawione na wersję standardu PDF/A-1b.

SoftMaskAction

Uzyskuje lub ustawia akcję, która ma być podjęta podczas konwersji obrazów z maskami.

public ConvertSoftMaskAction SoftMaskAction { get; set; }

Wartość właściwości

ConvertSoftMaskAction

Metody

AddInput(IDataSource)

Dodaje nowe źródło danych do kolekcji

public void AddInput(IDataSource dataSource)

Parametry

• dataSource IDataSource:

Klasa PdfAValidateOptions

public sealed class PdfAValidateOptions : PdfAOptionsBase, IPluginOptions  

Dziedziczenie

object ←
PdfAOptionsBase ←
PdfAValidateOptions

Implementuje

• IPluginOptions

Dziedziczone członkowie

• PdfAOptionsBase.AddInput(IDataSource),
• PdfAOptionsBase.Inputs,
• PdfAOptionsBase.PdfAVersion,
• PdfAOptionsBase.IsLowMemoryMode,
• PdfAOptionsBase.LogOutputSource,
• PdfAOptionsBase.ErrorAction,
• PdfAOptionsBase.SoftMaskAction,
• PdfAOptionsBase.CheckDifferentNamesInFontDictionaries,
• PdfAOptionsBase.AlignText,
• PdfAOptionsBase.OptimizeFileSize,
• PdfAOptionsBase.IccProfileFileName,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Konstruktorzy

PdfAValidateOptions()

public PdfAValidateOptions()  

Klasa PdfAValidationResult

public sealed class PdfAValidationResult

Dziedziczenie

object ← PdfAValidationResult

Członkowie dziedziczeni

• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Pola

• DataSource Zwraca źródło danych, które zostało zwalidowane.

Wartość pola

IDataSource

IsValid

Zwraca wartość wskazującą, czy walidacja zakończyła się sukcesem.

public readonly bool IsValid

Wartość pola

bool

StandardVersion

Zwraca wersję standardu PDF/A używaną do walidacji.

public readonly PdfAStandardVersion StandardVersion

Wartość pola

PdfAStandardVersion

Klasa PdfChatGpt

public sealed class PdfChatGpt : IDisposable

Dziedziczenie

object ← PdfChatGpt

Implementuje

• IDisposable

Ddziedziczone członkowie

• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Przykłady

Przykład pokazuje, jak używać wtyczki PdfChatGpt, dodając wiadomości do żądania.

using (var plugin = new PdfChatGpt())
{
    var options = new PdfChatGptRequestOptions();
    options.AddOutput(new FileDataSource("PdfChatGPT_output.pdf")); // Dodaj ścieżkę pliku wyjściowego.
    options.ApiKey = "Twój klucz API."; // Musisz podać klucz, aby uzyskać dostęp do API.
    options.MaxTokens = 1000; // Maksymalna liczba tokenów do wygenerowania w uzupełnieniu czatu.

    // Dodaj wiadomości żądania.
    options.Messages.Add(new Message
    {
        Content = "Jesteś pomocnym asystentem.",
        Role = Role.System
    });
    options.Messages.Add(new Message
    {
        Content = "Jaka jest największa średnica pizzy, jaka kiedykolwiek została zrobiona?",
        Role = Role.User
    });

    // Przetwórz żądanie.
    var result = await plugin.ProcessAsync(options);

    var fileResultPath = result.ResultCollection[0].Data;
    var chatCompletionObject = result.ResultCollection[1].Data as ChatCompletion; // Obiekt uzupełnienia czatu API ChatGPT.
}

Przykład pokazuje, jak używać wtyczki PdfChatGpt, dodając jedną wiadomość do żądania.

using (var plugin = new PdfChatGpt())
{
    var options = new PdfChatGptRequestOptions();
    options.AddOutput(new FileDataSource("PdfChatGPT_output.pdf")); // Dodaj ścieżkę pliku wyjściowego.
    options.ApiKey = "Twój klucz API."; // Musisz podać klucz, aby uzyskać dostęp do API.
    options.MaxTokens = 1000; // Maksymalna liczba tokenów do wygenerowania w uzupełnieniu czatu.

    // Dodaj wiadomość żądania.
    // W tym przypadku wiadomość systemowa z Content = "Jesteś pomocnym asystentem." jest dodawana domyślnie.
    // Rola wiadomości zapytania to "użytkownik" domyślnie.
    options.Query = "Jaka była najniższa temperatura zarejestrowana na Ziemi?";

    // Przetwórz żądanie.
    var result = await plugin.ProcessAsync(options);

    var fileResultPath = result.ResultCollection[0].Data;
    var chatCompletionObject = result.ResultCollection[1].Data as ChatCompletion; // Obiekt uzupełnienia czatu API ChatGPT.
}

Przykład pokazuje, jak używać wtyczki PdfChatGpt, dodając plik(i) jako źródło wiadomości.

using (var plugin = new PdfChatGpt())
{
    var options = new PdfChatGptRequestOptions();
    options.AddOutput(new FileDataSource("PdfChatGPT_output.pdf")); // Dodaj ścieżkę pliku wyjściowego.

    // Dodaj źródło tekstu PDF.
    // W przypadku wielu źródeł tekst z każdego dokumentu zostanie dodany do kolekcji wiadomości żądania
    // jako osobna wiadomość z rolą "użytkownik".
    options.AddInput(new FileDataSource("TextSource.pdf"));

    options.ApiKey = "Twój klucz API."; // Musisz podać klucz, aby uzyskać dostęp do API.
    options.MaxTokens = 1000; // Maksymalna liczba tokenów do wygenerowania w uzupełnieniu czatu.

    // Dodaj wiadomość żądania.
    // W tym przypadku wiadomość systemowa z Content = "Jesteś pomocnym asystentem." jest dodawana domyślnie.
    // Rola wiadomości zapytania to "użytkownik" domyślnie.
    options.Query = "Ile liter znajduje się w podanym tekście?";

    // Przetwórz żądanie.
    var result = await plugin.ProcessAsync(options);

    var fileResultPath = result.ResultCollection[0].Data;
    var chatCompletionObject = result.ResultCollection[1].Data as ChatCompletion; // Obiekt uzupełnienia czatu API ChatGPT.
}

Uwagi

Obiekt Documentize.PdfChatGpt jest używany do wysyłania żądań do ChatGPT bezpośrednio lub poprzez dodawanie źródeł plików PDF i zapisywanie odpowiedzi w źródle wyjściowym.

Konstruktory

PdfChatGpt()

Inicjalizuje nową instancję obiektu Documentize.PdfChatGpt.

public PdfChatGpt()

Metody

Dispose()

Implementacja IDisposable. W rzeczywistości nie jest to konieczne dla PdfChatGpt.

public void Dispose()

Process(IPluginOptions)

Metoda nie ma wersji synchronicznej. Użyj metody ProcessAsync zamiast tego.

public ResultContainer Process(IPluginOptions options)

Parametry

• options IPluginOptions: Obiekt opcji zawierający instrukcje dla PdfChatGpt.

Zwraca

ResultContainer : #### Wyjątki

NotImplementedException

ProcessAsync(IPluginOptions)

Rozpoczyna przetwarzanie PdfChatGpt z określonymi parametrami.

public Task<resultcontainer> ProcessAsync(IPluginOptions options)

Parametry

• options IPluginOptions: Obiekt opcji zawierający instrukcje dla PdfChatGpt.

Zwraca

Task<ResultContainer&gt;

Obiekt zadania reprezentujący operację asynchroniczną.

Wyjątki

ArgumentException : InvalidOperationException

SetCancellationToken(CancellationToken)

Ustawia token anulowania.

public void SetCancellationToken(CancellationToken cancellationToken)

Parametry

• cancellationToken CancellationToken: Token anulowania. :

Klasa PdfChatGptOptions

public class PdfChatGptOptions : IPluginOptions

Dziedziczenie

object ← PdfChatGptOptions

Pochodne

• PdfChatGptRequestOptions

Implementuje

• IPluginOptions

Członkowie dziedziczeni

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Konstruktory

PdfChatGptOptions()

Inicjalizuje nową instancję obiektu Documentize.PdfChatGptOptions.

public PdfChatGptOptions()

Właściwości

Inputs

public List<idatasource> Inputs { get; }

Wartość właściwości

List<IDataSource&gt;

Outputs

public List<idatasource> Outputs { get; }

Wartość właściwości

List<IDataSource&gt;

Metody

AddInput(IDataSource)

Dodaje nowe źródło danych do kolekcji danych wtyczki PdfChatGpt.

public void AddInput(IDataSource dataSource)

Parametry

• dataSource IDataSource: Źródło danych (plik lub strumień) do dodania.

AddOutput(IDataSource)

Dodaje nowe źródło danych do zapisu do kolekcji danych wtyczki PdfChatGpt.

public void AddOutput(IDataSource saveDataSource)

Parametry

• saveDataSource IDataSource: Źródło danych (plik lub strumień) do zapisywania wyników operacji. :

Klasa PdfChatGptRequestOptions

public class PdfChatGptRequestOptions : PdfChatGptOptions, IPluginOptions  

Dziedziczenie

obiekt ←
PdfChatGptOptions ←
PdfChatGptRequestOptions

Implementuje

• IPluginOptions

Członkowie Dziedziczeni

• PdfChatGptOptions.AddInput(IDataSource),
• PdfChatGptOptions.AddOutput(IDataSource),
• PdfChatGptOptions.Inputs,
• PdfChatGptOptions.Outputs,
• obiekt.GetType(),
• obiekt.MemberwiseClone(),
• obiekt.ToString(),
• obiekt.Equals(obiekt?),
• obiekt.Equals(obiekt?, obiekt?),
• obiekt.ReferenceEquals(obiekt?, obiekt?),
• obiekt.GetHashCode()

Konstruktory

PdfChatGptRequestOptions()

Inicjalizuje nową instancję obiektu Documentize.PdfChatGptRequestOptions z domyślnymi opcjami.

public PdfChatGptRequestOptions()  

PdfChatGptRequestOptions(string, string, string, string)

Inicjalizuje nową instancję obiektu Documentize.PdfChatGptRequestOptions z opcjami.

public PdfChatGptRequestOptions(string apiKey, string model, string apiUrl, string query)  

Parametry

• apiKey string: Klucz do dostępu do API ChatGPT.
• model string: Nazwa modelu ChatGPT. Domyślny model to: gpt-3.5-turbo-1106:
• apiUrl string: Adres URL API ChatGPT. Domyślny adres URL to: https://api.openai.com/v1/chat/completions.
• query string: Ciąg zapytania do ChatGPT.

Właściwości

ApiKey

Pobiera lub ustawia klucz dostępu do API ChatGPT.

public string ApiKey { get; set; }  

Wartość Właściwości

string

ApiUrl

Pobiera lub ustawia adres URL API ChatGPT.

public string ApiUrl { get; set; }  

Wartość Właściwości

string

MaxTokens

Maksymalna liczba tokenów w odpowiedzi.
Domyślna wartość to null, co oznacza nieskończoność.

public int? MaxTokens { get; set; }  

Wartość Właściwości

int?

Messages

Pobiera lub ustawia kolekcję obiektów Documentize.Message.

public List<message> Messages { get; set; }  

Wartość Właściwości

List<Message&gt;

Model

Ustawia lub pobiera ID modelu do użycia.

public string Model { get; set; }  

Wartość Właściwości

string

NumberOfChoices

Ile wyborów zakończenia czatu należy wygenerować dla każdej wiadomości wejściowej.

public int NumberOfChoices { get; set; }  

Wartość Właściwości

int

Query

Pobiera lub ustawia ciąg zapytania do ChatGPT.
Jeśli nie jest pusty, to jest pierwsza wiadomość w kolekcji,
która zostanie wysłana w żądaniu.

public string Query { get; set; }  

Wartość Właściwości

string

Temperature

Jaką temperaturę próbkowania użyć, pomiędzy 0 a 2.
Wyższe wartości jak 0.8 sprawią, że wyjście będzie bardziej losowe,
podczas gdy niższe wartości jak 0.2 uczynią je bardziej skupionym i deterministycznym.
Domyślna wartość to 1.

public double Temperature { get; set; }  

Wartość Właściwości

double

Klasa PdfConverterOptions

public abstract class PdfConverterOptions : IPluginOptions  

Dziedziczenie

object ←
PdfConverterOptions

Pochodne

• PdfToDocOptions,
• PdfToHtmlOptions,
• PdfToXlsOptions

Implementuje

• IPluginOptions

Członkowie dziedziczeni

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Właściwości

Wejścia

Zwraca kolekcję danych wtyczki PdfConverterOptions.

public List<idatasource> Inputs { get; }  

Wartość właściwości

List<IDataSource&gt;

Wyjścia

Pobiera kolekcję dodanych celów dla wyników operacji zapisywania.

public List<idatasource> Outputs { get; }  

Wartość właściwości

List<IDataSource&gt;

Metody

AddInput(IDataSource)

Dodaje nowe źródło danych do kolekcji danych wtyczki PdfConverter.

public void AddInput(IDataSource dataSource)  

Parametry

• dataSource IDataSource: Źródło danych do dodania.

AddOutput(IDataSource)

Dodaje nowe źródło danych do kolekcji danych wtyczki PdfToXLSXConverterOptions.

public void AddOutput(IDataSource saveDataSource)  

Parametry

• saveDataSource IDataSource: Źródło danych (plik lub strumień) do zapisywania wyników operacji.

Wyjątki

NotImplementedException

Klasa PdfExtractor

public abstract class PdfExtractor : IDisposable

Dziedziczenie

obiekt ← PdfExtractor

Pochodne

• ImageExtractor,
• TextExtractor

Implementuje

• IDisposable

Członkowie dziedziczeni

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Przykłady

Przykład pokazuje, jak wyodrębnić treść tekstową z dokumentu PDF.

// utwórz obiekt TextExtractor, aby wyodrębnić zawartość PDF
using (TextExtractor extractor = new TextExtractor())
{
    // utwórz obiekt TextExtractorOptions, aby ustawić instrukcje
    textExtractorOptions = new TextExtractorOptions();

    // dodaj ścieżkę do pliku wejściowego
    textExtractorOptions.AddInput(new FileDataSource(inputPath));

    // wykonaj proces ekstrakcji
    ResultContainer resultContainer = extractor.Process(textExtractorOptions);

    // uzyskaj wyodrębniony tekst z obiektu ResultContainer
    string textExtracted = resultContainer.ResultCollection[0].ToString();
}

Uwagi

Obiekt Documentize.TextExtractor jest używany do ekstrakcji tekstu, a Documentize.ImageExtractor do ekstrakcji obrazów.

Konstruktory

PdfExtractor()

protected PdfExtractor()

Metody

Dispose()

Implementacja IDisposable. Właściwie, nie jest to konieczne dla PdfExtractor.

public void Dispose()

Process(IPluginOptions)

Rozpoczyna przetwarzanie PdfExtractor z określonymi parametrami.

public ResultContainer Process(IPluginOptions pdfExtractorOptions)

Parametry

• pdfExtractorOptions IPluginOptions: Obiekt opcji zawierający instrukcje dla PdfExtractor.

Zwraca

ResultContainer : Obiekt ResultContainer zawierający rezultat ekstrakcji.

Klasa PdfExtractorOptions

public abstract class PdfExtractorOptions : IPluginOptions  

Dziedziczenie

object ←
PdfExtractorOptions

Pochodne

• ImageExtractorOptions,
• TextExtractorOptions

Implementuje

• IPluginOptions

Członkowie dziedziczeni

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Uwagi

Documentize.PdfExtractorOptions zawiera podstawowe funkcje do dodawania danych (plików, strumieni) reprezentujących dokumenty PDF wejściowe.
Proszę utworzyć Documentize.TextExtractorOptions lub ImageExtractorOptions zamiast tego.

Właściwości

Wejścia

Zwraca kolekcję danych wtyczki PdfExtractor.

public List<idatasource> Inputs { get; }  

Wartość właściwości

List<IDataSource&gt;

NazwaOperacji

Zwraca nazwę operacji

public virtual string OperationName { get; }  

Wartość właściwości

string

Metody

DodajWejście(IDataSource)

Dodaje nowe źródło danych do kolekcji danych wtyczki PdfExtractor.

public void AddInput(IDataSource dataSource)  

Parametry

• dataSource IDataSource: Źródło danych do dodania. :

Klasa PdfToDocOptions

public sealed class PdfToDocOptions : PdfConverterOptions, IPluginOptions

Dziedziczenie

object ← PdfConverterOptions ← PdfToDocOptions

Implementuje

• IPluginOptions

Członkowie dziedziczeni

• PdfConverterOptions.AddInput(IDataSource),
• PdfConverterOptions.AddOutput(IDataSource),
• PdfConverterOptions.Inputs,
• PdfConverterOptions.Outputs,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Konstruktorzy

PdfToDocOptions()

Inicjalizuje nową instancję obiektu Documentize.PdfToDocOptions z domyślnymi opcjami.

public PdfToDocOptions()

Klasa PdfToHtmlOptions

public sealed class PdfToHtmlOptions : PdfConverterOptions, IPluginOptions

Dziedziczenie

object ← PdfConverterOptions ← PdfToHtmlOptions

Implementuje

• IPluginOptions

Członkowie dziedziczeni

• PdfConverterOptions.AddInput(IDataSource),
• PdfConverterOptions.AddOutput(IDataSource),
• PdfConverterOptions.Inputs,
• PdfConverterOptions.Outputs,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Konstruktory

PdfToHtmlOptions()

Inicjalizuje nową instancję obiektu Documentize.PdfToHtmlOptions z domyślnymi opcjami.

public PdfToHtmlOptions()

PdfToHtmlOptions(SaveDataType)

Inicjalizuje nową instancję obiektu Documentize.PdfToHtmlOptions dla określonego typu danych wyjściowych.

public PdfToHtmlOptions(PdfToHtmlOptions.SaveDataType outputDataType)

Parametry

• outputDataType PdfToHtmlOptions.SaveDataType: Typ danych wyjściowych.

Właściwości

OutputDataType

Uzyskuje typ danych wyjściowych.

public PdfToHtmlOptions.SaveDataType OutputDataType { get; }

Wartość właściwości

PdfToHtmlOptions.SaveDataType

Klasa PdfToJpegOptions

public sealed class PdfToJpegOptions : PluginBaseOptions, IPluginOptions

Dziedziczenie

obiekt ← PluginBaseOptions ← PdfToJpegOptions

Implementuje

• IPluginOptions

Członkowie dziedziczeni

• PluginBaseOptions.AddInput(IDataSource),
• PluginBaseOptions.AddOutput(IDataSource),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Konstruktorzy

PdfToJpegOptions()

Inicjuje nową instancję obiektu Documentize.PdfToJpegOptions.

public PdfToJpegOptions()

Właściwości

OutputResolution

Pobiera lub ustawia wartość rozdzielczości wynikowych obrazów.

public int OutputResolution { get; set; }

Wartość właściwości

int

PageList

Pobiera lub ustawia listę stron do przetworzenia.

public List<int> PageList { get; set; }

Wartość właściwości

List<int&gt;

Quality

Pobiera i ustawia jakość wyjściową.

public int Quality { get; set; }

Wartość właściwości

int

Klasa PdfToPngOptions

public sealed class PdfToPngOptions : PluginBaseOptions, IPluginOptions

Dziedziczenie

object ← PluginBaseOptions ← PdfToPngOptions

Implementuje

• IPluginOptions

Członkowie dziedziczeni

• PluginBaseOptions.AddInput(IDataSource),
• PluginBaseOptions.AddOutput(IDataSource),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Konstruktorzy

PdfToPngOptions()

Inicjuje nową instancję obiektu Documentize.PdfToPngOptions.

public PdfToPngOptions()

Właściwości

OutputResolution

Pobiera lub ustawia wartość rozdzielczości wynikowych obrazów.

public int OutputResolution { get; set; }

Wartość właściwości

int

PageList

Pobiera lub ustawia listę stron do przetworzenia.

public List<int> PageList { get; set; }

Wartość właściwości

List<int&gt;

Klasa PdfToTiffOptions

public sealed class PdfToTiffOptions : PluginBaseOptions, IPluginOptions

Dziedziczenie

object ← PluginBaseOptions ← PdfToTiffOptions

Implementuje

• IPluginOptions

Członkowie dziedziczeni

• PluginBaseOptions.AddInput(IDataSource),
• PluginBaseOptions.AddOutput(IDataSource),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Konstruktory

PdfToTiffOptions()

Inicjalizuje nową instancję obiektu Documentize.PdfToTiffOptions.

public PdfToTiffOptions()

Właściwości

MultiPage

Pobiera i ustawia flagę, która pozwala na zapisanie wszystkich stron w jednym wielostronicowym TIFF.

public bool MultiPage { get; set; }

Wartość właściwości

bool

OutputResolution

Pobiera lub ustawia wartość rozdzielczości wynikowych obrazów.

public int OutputResolution { get; set; }

Wartość właściwości

int

PageList

Pobiera lub ustawia listę stron do przetworzenia.

public List<int> PageList { get; set; }

Wartość właściwości

List<int&gt;

Klasa PdfToXlsOptions

public sealed class PdfToXlsOptions : PdfConverterOptions, IPluginOptions

Dziedziczenie

object ← PdfConverterOptions ← PdfToXlsOptions

Implementuje

• IPluginOptions

Członkowie dziedziczeni

• PdfConverterOptions.AddInput(IDataSource),
• PdfConverterOptions.AddOutput(IDataSource),
• PdfConverterOptions.Inputs,
• PdfConverterOptions.Outputs,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Konstruktorzy

PdfToXlsOptions()

Inicjalizuje nową instancję obiektu Documentize.PdfToXlsOptions z domyślnymi opcjami.

public PdfToXlsOptions()

Właściwości

Format

Format wyjściowy.

public PdfToXlsOptions.ExcelFormat Format { get; set; }

Wartość właściwości

PdfToXlsOptions.ExcelFormat

InsertBlankColumnAtFirst

Ustaw prawdę, jeśli potrzebujesz wstawić pustą kolumnę jako pierwszą kolumnę arkusza roboczego. Domyślna wartość to fałsz; oznacza to, że pusta kolumna nie zostanie wstawiona.

public bool InsertBlankColumnAtFirst { get; set; }

Wartość właściwości

bool

MinimizeTheNumberOfWorksheets

Ustaw prawdę, jeśli chcesz zminimalizować liczbę arkuszy roboczych w wynikowym skoroszycie. Domyślna wartość to fałsz; oznacza to zapisanie każdej strony PDF jako oddzielnego arkusza roboczego.

public bool MinimizeTheNumberOfWorksheets { get; set; }

Wartość właściwości

bool

Klasa PluginBaseOptions

public class PluginBaseOptions : IPluginOptions  

Dziedziczenie

object ←
PluginBaseOptions

Pochodne

• AddTimestampOptions,
• CompressOptions,
• DecryptionOptions,
• EncryptionOptions,
• HtmlToPdfOptions,
• MergeOptions,
• OptimizeOptions,
• PdfToJpegOptions,
• PdfToPngOptions,
• PdfToTiffOptions,
• ResizeOptions,
• RotateOptions,
• SignOptions,
• SplitOptions,
• TableOptions

Implementuje

• IPluginOptions

Członkowie przejęci

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Właściwości

CloseInputStreams

Zamknij strumienie wejściowe po zakończeniu operacji.

public bool CloseInputStreams { get; set; }  

Wartość właściwości

bool

CloseOutputStreams

Zamknij strumienie wyjściowe po zakończeniu operacji.

public bool CloseOutputStreams { get; set; }  

Wartość właściwości

bool

Inputs

Zwraca dane wejściowe dla operacji.

public List<idatasource> Inputs { get; }  

Wartość właściwości

List<IDataSource&gt;

Outputs

Zwraca dane wyjściowe dla operacji.

public List<idatasource> Outputs { get; }  

Wartość właściwości

List<IDataSource&gt;

Metody

AddInput(IDataSource)

Dodaje nowe dane do wejść.

public void AddInput(IDataSource dataSource)  

Parametry

• dataSource IDataSource: Dane do dodania.

AddOutput(IDataSource)

Dodaje nowe dane do wyjść.

public void AddOutput(IDataSource saveDataSource)  

Parametry

• saveDataSource IDataSource: Dane do dodania. :

Klasa PngConverter

public sealed class PngConverter  

Dziedziczenie

object ←
PngConverter

Członkowie dziedziczeni

• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Przykłady

Przykład pokazuje, jak skonwertować dokument PDF na format PNG.

// utwórz PngConverter  
var plugin = new PngConverter();  
// utwórz obiekt PdfToPngOptions, aby ustawić instrukcje  
var opt = new PdfToPngOptions();  
// dodaj ścieżkę do pliku wejściowego  
opt.AddInput(new FileDataSource(inputPath));  
// ustaw ścieżkę do pliku wyjściowego  
opt.AddOutput(new DirectoryDataSource(outputPath));  
// wykonaj proces  
plugin.Process(opt);  

Konstruktory

PngConverter()

public PngConverter()  

Metody

Process(PdfToPngOptions)

Rozpoczyna przetwarzanie Documentize.PngConverter z określonymi parametrami.

public ResultContainer Process(PdfToPngOptions options)  

Parametry

• options PdfToPngOptions: Obiekt opcji zawierający instrukcje dla Documentize.PngConverter.

Zwraca

ResultContainer : Obiekt ResultContainer zawierający wynik operacji.

Klasa Prostokąt

public class Rectangle

Dziedziczenie

object ← Rectangle

Członkowie dziedziczeni

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Konstruktorzy

Rectangle(double, double, double, double)

Konstruktor prostokąta.

public Rectangle(double llx, double lly, double urx, double ury)

Parametry

• llx double: X lewego dolnego rogu.
• lly double: Y lewego dolnego rogu.
• urx double: X prawego górnego rogu.
• ury double: Y prawego górnego rogu.

Klasa ResizeOptions

public sealed class ResizeOptions : PluginBaseOptions, IPluginOptions  

Dziedziczenie

object ←
PluginBaseOptions ←
ResizeOptions

Implementuje

• IPluginOptions

Członkowie dziedziczeni

• PluginBaseOptions.AddInput(IDataSource),
• PluginBaseOptions.AddOutput(IDataSource),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Konstruktory

ResizeOptions()

Inicjalizuje nową instancję obiektu Documentize.ResizeOptions z domyślnymi opcjami.

public ResizeOptions()  

Właściwości

PageSize

Ustawia lub zwraca nowy rozmiar strony.

public PageSize PageSize { get; set; }  

Wartość właściwości

PageSize

Klasa ResultContainer

public class ResultContainer  

Dziedziczenie

object ←
ResultContainer

Członkowie dziedziczeni

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Właściwości

ResultCollection

Zwraca kolekcję wyników operacji

public List<ioperationresult> ResultCollection { get; }  

Wartość właściwości

List<IOperationResult&gt;

Klasa RotateOptions

public sealed class RotateOptions : PluginBaseOptions, IPluginOptions

Dziedziczenie

object ← PluginBaseOptions ← RotateOptions

Implementuje

• IPluginOptions

Członkowie dziedziczeni

• PluginBaseOptions.AddInput(IDataSource),
• PluginBaseOptions.AddOutput(IDataSource),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Konstruktory

RotateOptions()

Inicjalizuje nową instancję obiektu Documentize.RotateOptions z domyślnymi opcjami.

public RotateOptions()

Właściwości

Rotation

Pobiera lub ustawia nową rotację stron.

public Rotation Rotation { get; set; }

Wartość właściwości

Rotation

Klasa StreamDataSource

public sealed class StreamDataSource : IDataSource  

Dziedziczenie

object ←
StreamDataSource

Implementuje

• IDataSource

Członkowie dziedziczeni

• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Konstruktorzy

StreamDataSource(Stream)

Inicjalizuje nowe źródło danych strumieniowych z określonym obiektem strumienia.

public StreamDataSource(Stream data)  

Parametry

• data Stream: Obiekt strumienia

Właściwości

Data

Zwraca obiekt strumienia bieżącego źródła danych.

public Stream Data { get; }  

Wartość właściwości

Stream

DataType

Typ źródła danych (strumień).

public DataType DataType { get; }  

Wartość właściwości