Subsections of Documentize Namespace
Class CompressOptions
Info
Αναπαριστά τις επιλογές συμπίεσης για το plugin Documentize.Optimizer.
public sealed class CompressOptions : PluginBaseOptions, IPluginOptions
Κληρονομικότητα
object ←
PluginBaseOptions ←
CompressOptions
Υλοποιεί
Κληρονομημένα Μέλη
- 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()
Κατασκευαστές
CompressOptions()
Αρχικοποιεί μια νέα παρουσία του αντικειμένου Documentize.CompressOptions με τις προεπιλεγμένες επιλογές.
Class PdfAConvertOptions
Info
Αναπαριστά επιλογές για τη μετατροπή PDF εγγράφων σε μορφή PDF/A με το πρόσθετο Documentize.PdfAConverter.
public sealed class PdfAConvertOptions : PdfAOptionsBase, IPluginOptions
Κληρονομικότητα
object ←
PdfAOptionsBase ←
PdfAConvertOptions
Υλοποιεί
Κληρονομούμενα Μέλη
- 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()
Κατασκευαστές
PdfAConvertOptions()
public PdfAConvertOptions()
Ιδιότητες
Outputs
Αποκτά τη συλλογή των προστιθέμενων στόχων (πηγές δεδομένων αρχείου ή ροής) για την αποθήκευση των αποτελεσμάτων λειτουργίας.
public List<idatasource> Outputs { get; }
Τιμή Ιδιότητας
List<IDataSource>
Μέθοδοι
AddOutput(IDataSource)
Προσθέτει νέο στόχο αποθήκευσης αποτελέσματος.
public void AddOutput(IDataSource dataSource)
Παράμετροι
dataSource
IDataSource: Στόχος (πηγή δεδομένων αρχείου ή ροής) για την αποθήκευση των αποτελεσμάτων λειτουργίας. :
Class PdfAValidationResult
Info
Αναπαριστά το αποτέλεσμα μιας διαδικασίας επικύρωσης PDF/A.
public sealed class PdfAValidationResult
Κληρονομικότητα
object ←
PdfAValidationResult
Κληρονομούμενα Μέλη
Πεδία
DataSource Λαμβάνει την πηγή δεδομένων που επικυρώθηκε.
Τιμή Πεδίου
IDataSource
IsValid
Λαμβάνει μια τιμή που υποδεικνύει αν η επικύρωση ήταν επιτυχής.
public readonly bool IsValid
Τιμή Πεδίου
bool
StandardVersion
Λαμβάνει την έκδοση προτύπου PDF/A που χρησιμοποιήθηκε για την επικύρωση.
public readonly PdfAStandardVersion StandardVersion
Τιμή Πεδίου
PdfAStandardVersion
Class PdfChatGptRequestOptions
Info
Αναπαριστά τις επιλογές για το plugin Documentize.PdfChatGpt.
public class PdfChatGptRequestOptions : PdfChatGptOptions, IPluginOptions
Κληρονομικότητα
object ←
PdfChatGptOptions ←
PdfChatGptRequestOptions
Υλοποιεί
Κληρονομημένα Μέλη
- PdfChatGptOptions.AddInput(IDataSource),
- PdfChatGptOptions.AddOutput(IDataSource),
- PdfChatGptOptions.Inputs,
- PdfChatGptOptions.Outputs,
- object.GetType(),
- object.MemberwiseClone(),
- object.ToString(),
- object.Equals(object?),
- object.Equals(object?, object?),
- object.ReferenceEquals(object?, object?),
- object.GetHashCode()
Κατασκευαστές
PdfChatGptRequestOptions()
Αρχικοποιεί μια νέα παρουσία του αντικειμένου Documentize.PdfChatGptRequestOptions με προεπιλεγμένες επιλογές.
public PdfChatGptRequestOptions()
PdfChatGptRequestOptions(string, string, string, string)
Αρχικοποιεί μια νέα παρουσία του αντικειμένου Documentize.PdfChatGptRequestOptions με επιλογές.
public PdfChatGptRequestOptions(string apiKey, string model, string apiUrl, string query)
Παράμετροι
apiKey
string: Το κλειδί πρόσβασης στο API του ChatGPT.model
string: Το όνομα του μοντέλου ChatGPT. Το προεπιλεγμένο μοντέλο είναι: gpt-3.5-turbo-1106:apiUrl
string: Η διεύθυνση URL του API του ChatGPT. Η προεπιλεγμένη διεύθυνση είναι: https://api.openai.com/v1/chat/completions.query
string: Η συμβολοσειρά αιτήματος προς το ChatGPT.
Ιδιότητες
ApiKey
Αποκτά ή ορίζει το κλειδί πρόσβασης στο API του ChatGPT.
public string ApiKey { get; set; }
Τιμή Ιδιοτήτων
string
ApiUrl
Αποκτά ή ορίζει τη διεύθυνση URL του API του ChatGPT.
public string ApiUrl { get; set; }
Τιμή Ιδιοτήτων
string
MaxTokens
Μέγιστος αριθμός τουokens στην απάντηση.
Η προεπιλεγμένη τιμή είναι null, που σημαίνει άπειρο.
public int? MaxTokens { get; set; }
Τιμή Ιδιοτήτων
int?
Messages
Αποκτά ή ορίζει μια συλλογή των αντικειμένων Documentize.Message.
public List<message> Messages { get; set; }
Τιμή Ιδιοτήτων
List<Message>
Model
Ορίζει ή αποκτά το ID του μοντέλου προς χρήση.
public string Model { get; set; }
Τιμή Ιδιοτήτων
string
NumberOfChoices
Πόσες επιλογές ολοκλήρωσης συνομιλίας να παραχθούν για κάθε μήνυμα εισόδου.
public int NumberOfChoices { get; set; }
Τιμή Ιδιοτήτων
int
Query
Αποκτά ή ορίζει τη συμβολοσειρά αιτήματος προς το ChatGPT.
Αν δεν είναι κενή, αυτό είναι το πρώτο μήνυμα στη συλλογή,
που θα αποσταλεί στην αίτηση.
public string Query { get; set; }
Τιμή Ιδιοτήτων
string
Temperature
Ποια θερμοκρασία δειγματοληψίας να χρησιμοποιηθεί, μεταξύ 0 και 2.
Υψηλότερες τιμές όπως 0.8 θα κάνουν την έξοδο πιο τυχαία,
ενώ χαμηλότερες τιμές όπως 0.2 θα την κάνουν πιο συγκεντρωμένη και καθοριστική.
Η προεπιλεγμένη τιμή είναι 1.
public double Temperature { get; set; }
Τιμή Ιδιοτήτων
double
Class XlsConverter
Info
Αναπαριστά το plugin Documentize.XlsConverter. Χρησιμοποιείται για τη μετατροπή εγγράφων PDF σε μορφή XLSX/XLS.
public sealed class XlsConverter
Κληρονομικότητα
object ←
XlsConverter
Κληρονομημένα Μέλη
Παραδείγματα
Το παράδειγμα δείχνει πώς να μετατρέψετε έγγραφα PDF σε XLSX.
// create XlsConverter
var plugin = new XlsConverter();
// create PdfToXlsOptions
var opt = new PdfToXlsOptions();
// add input file path
opt.AddInput(new FileDataSource(inputPath));
// set output file path
opt.AddOutput(new FileDataSource(outputPath));
// perform the process
plugin.Process(opt);
Κατασκευαστές
XlsConverter()
Μέθοδοι
Process(PdfToXlsOptions)
Αρχίζει τη διαδικασία Documentize.XlsConverter με τις καθορισμένες παραμέτρους.
public ResultContainer Process(PdfToXlsOptions options)
Παράμετροι
options
PdfToXlsOptions: Ένα αντικείμενο επιλογών που περιέχει οδηγίες για τη λειτουργία.
Επιστροφή
ResultContainer : Ένα αντικείμενο Documentize.ResultContainer που περιέχει το αποτέλεσμα της λειτουργίας.
Enum ConvertErrorAction
Info
Αυτή η κλάση αντιπροσωπεύει ενέργειες για σφάλματα μετατροπής.
public enum ConvertErrorAction
Fields
Enum ConvertSoftMaskAction
Info
Αυτή η ενέργεια αντιπροσωπεύει ενέργειες για τη μετατροπή εικόνων με μαλακή μάσκα.
public enum ConvertSoftMaskAction
Fields
ConvertToStencilMask = 1
: Η μαλακή μάσκα θα μετατραπεί σε μάσκα στένσιλ.Default = 0
: Χρήση προεπιλεγμένης στρατηγικής.
Enum DataType
Info
Αναπαριστά τους πιθανους τύπους δεδομένων για την επεξεργασία plugin.
Fields
Directory = 2
: Ο τύπος δεδομένων είναι ένας κατάλογος που αναπαρίσταται από τη διαδρομή προς αυτόν.File = 0
: Ο τύπος δεδομένων είναι ένα αρχείο που αναπαρίσταται από τη διαδρομή προς αυτό.Stream = 1
: Ο τύπος δεδομένων είναι ροή.
Info
Καθορίζει τους πιθανούς τύπους μέσων που χρησιμοποιούνται κατά την απόδοση.
public enum HtmlMediaType
Fields
Print = 0
: Εκτύπωση.Screen = 1
: Οθόνη.
Enum HtmlPageLayoutOption
Info
Καθορίζει σημαίες που μαζί με άλλες επιλογές προσδιορίζουν τα μεγέθη και τους σχεδιασμούς σελίδων.
public enum HtmlPageLayoutOption
Fields
FitToWidestContentWidth = 3
: Υποδεικνύει ότι το πλάτος της σελίδας καθορίζεται από το μέγεθος του περιεχομένου και όχι από το καθορισμένο πλάτος σελίδας.None = 0
: Προεπιλεγμένη τιμή που υποδεικνύει ότι η HtmlPageLayoutOption δεν θα επηρεάσει τα μεγέθη και τους σχεδιασμούς σελίδων.ScaleToPageWidth = 256
: Υποδεικνύει ότι το περιεχόμενο του εγγράφου θα προσαρμοστεί για να ταιριάζει με τη σελίδα.
Enum PdfAStandardVersion
Info
Καθορίζει την έκδοση προτύπου PDF/A για ένα έγγραφο PDF.
public enum PdfAStandardVersion
Fields
Auto = 0
: Η έκδοση προτύπου PDF/A προσδιορίζεται αυτόματα.PDF_A_1A = 1
: Καθορίζει την έκδοση προτύπου PDF/A-1a.PDF_A_1B = 2
: Καθορίζει την έκδοση προτύπου PDF/A-1b.PDF_A_2A = 3
: Καθορίζει την έκδοση προτύπου PDF/A-2a.PDF_A_2B = 4
: Καθορίζει την έκδοση προτύπου PDF/A-2b.PDF_A_2U = 5
: Καθορίζει την έκδοση προτύπου PDF/A-2u.PDF_A_3A = 6
: Καθορίζει την έκδοση προτύπου PDF/A-3a.PDF_A_3B = 7
: Καθορίζει την έκδοση προτύπου PDF/A-3b.PDF_A_3U = 8
: Καθορίζει την έκδοση προτύπου PDF/A-3u.
Enum PdfToHtmlOptions.SaveDataType
Info
Ορίζει τον τύπο εξόδου του αρχείου HTML.
public enum PdfToHtmlOptions.SaveDataType
Fields
FileWithEmbeddedResources = 1
: Αποθήκευση HTML σε αρχείο με ενσωματωμένους πόρουςFileWithExternalResources = 0
: Αποθήκευση HTML σε αρχείο με εξωτερικούς πόρουςStreamWithEmbeddedResources = 2
: Αποθήκευση HTML σε ροή αρχείου με ενσωματωμένους πόρους
Info
Επιτρέπει την καθορισμό μορφής αρχείου .xlsx, .xls/xml ή csv. Η προεπιλεγμένη τιμή είναι XLSX.
Επιτρέπει την καθορισμό μορφής αρχείου .xlsx, .xls/xml ή csv.
Η προεπιλεγμένη τιμή είναι XLSX.
public enum PdfToXlsOptions.ExcelFormat
Fields
CSV = 2
: Μορφή Αρχείου τιμών διαχωρισμένων με κόμμα (CSV).ODS = 4
: Ανοιχτό Έγγραφο Φύλλου Εργασίας.XLSM = 3
: Μορφή Αρχείου Office Open XML (.xlsm) με δυνατότητα μακροεντολών.XLSX = 1
: Μορφή Αρχείου Office Open XML (.xlsx).XMLSpreadSheet2003 = 0
: Μορφή Αρχείου Excel 2003 XML (.xls).
Enum Rotation
Info
Καταμέτρηση πιθανών τιμών περιστροφής.
Fields
None = 0
: Μη περιστραμμένο.On180 = 2
: Περιστραμμένο κατά 180 μοίρες.On270 = 3
: Περιστραμμένο κατά 270 μοίρες δεξιόστροφα.On360 = 4
: Περιστραμμένο κατά 360 μοίρες δεξιόστροφα.On90 = 1
: Περιστραμμένο κατά 90 μοίρες δεξιόστροφα.
Info
Ορίζει διαφορετικούς τρόπους που μπορούν να χρησιμοποιηθούν κατά τη μετατροπή ενός εγγράφου PDF σε κείμενο. Δείτε την κλάση Documentize.TextExtractorOptions.
public enum TextExtractorOptions.TextFormattingMode
Fields
Plain = 2
: Αντιπροσωπεύει το περιεχόμενο κειμένου PDF λαμβάνοντας υπόψη τη σχετική θέση των τμημάτων κειμένου αλλά χωρίς να προστίθενται επιπλέον κενά.Pure = 0
: Αντιπροσωπεύει το περιεχόμενο κειμένου PDF με μερικές ρουτίνες μορφοποίησης. Αυτό περιλαμβάνει την αναγνώριση σχετικών θέσεων και την προσθήκη επιπλέον κενών για να ευθυγραμμιστεί το κείμενο στο πλάτος της σελίδας.Raw = 1
: Αντιπροσωπεύει το περιεχόμενο PDF όπως είναι, δηλαδή χωρίς μορφοποίηση.
Enum Ρόλος
Info
Ο ρόλος του συγγραφέα των μηνυμάτων.
Fields
Assistant = 2
System = 1
User = 0
Generator Πίνακα Κλάσης
Info
Αντιπροσωπεύει το plugin Documentize.TableGenerator. Χρησιμοποιείται για την προσθήκη ενός πίνακα σε ένα αρχείο PDF.
public sealed class TableGenerator
Κληρονομικότητα
object ←
TableGenerator
Κληρονομούμενα Μέλη
Παραδείγματα
Το παράδειγμα δείχνει πώς να προσθέσετε πίνακα σε αρχείο PDF.
// δημιουργία TableGenerator
var plugin = new TableGenerator();
// δημιουργία αντικειμένου TableOptions για να ορίσετε οδηγίες
TableOptions opt = new TableOptions().InsertPageBefore(1)
.AddTable()
.AddRow()
.AddCell().AddParagraph("Όνομα")
.AddCell().AddParagraph("Ηλικία")
.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");
// προσθήκη διαδρομής εισόδου
opt.AddInput(new FileDataSource(inputPath1));
// ορισμός διαδρομής εξόδου
opt.AddOutput(new FileDataSource(outputPath));
// εκτέλεση της διαδικασίας
plugin.Process(opt);
Κατασκευαστές
TableGenerator()
Μέθοδοι
Process(TableOptions)
Ξεκινά τη διαδικασία Documentize.TableGenerator με τις καθορισμένες παραμέτρους.
public ResultContainer Process(TableOptions options)
Παράμετροι
options
TableOptions: Ένα αντικείμενο επιλογών που περιέχει οδηγίες για το Documentize.TableGenerator.
Επιστρέφει
ResultContainer : Ένα αντικείμενο ResultContainer που περιέχει το αποτέλεσμα της λειτουργίας.
Άδεια Κατηγορίας
Info
Παρέχει μέθοδο για να οριστεί η Άδεια.
public static class License
Κληρονομικότητα
object ←
License
Κληρονομούμενα Μέλη
Παραδείγματα
Δείχνει πώς να ενεργοποιήσετε μια άδεια.
// Ορισμός Άδειας
License.Set("PathToLicense.lic");
Μέθοδοι
Set(string)
Αδειοδοτεί το στοιχείο.
public static void Set(string licenseName)
Παράμετροι
licenseName
string: Μπορεί να είναι πλήρες ή σύντομο όνομα αρχείου. Χρησιμοποιήστε μια κενή συμβολοσειρά για να переключитесь σε λειτουργία εκτίμησης.
Αποτέλεσμα Αντικειμένου Κατηγορίας
Info
Αναπαριστά το αποτέλεσμα μιας λειτουργίας με τη μορφή συμβολοσειράς.
public sealed class ObjectResult : IOperationResult
Κληρονομία
object ←
ObjectResult
Υλοποιεί
Κληρονομούμενα Μέλη
Ιδιότητες
Δεδομένα
Αποκτά ακατέργαστα δεδομένα.
public object Data { get; }
Τιμή Ιδιότητας
object
ΕίναιΑρχείο
Δηλώνει αν το αποτέλεσμα είναι μια διαδρομή σε ένα αρχείο εξόδου.
public bool IsFile { get; }
Τιμή Ιδιότητας
bool
ΕίναιΑντικείμενο
Δηλώνει αν το αποτέλεσμα είναι ένα αντικείμενο.
public bool IsObject { get; }
Τιμή Ιδιότητας
bool
ΕίναιΡεύμα
Δηλώνει αν το αποτέλεσμα είναι μια διαδρομή σε ένα αρχείο εξόδου.
public bool IsStream { get; }
Τιμή Ιδιότητας
bool
ΕίναιΣυμβολοσειρά
Δηλώνει αν το αποτέλεσμα είναι μια συμβολοσειρά.
public bool IsString { get; }
Τιμή Ιδιότητας
bool
Κείμενο
Επιστρέφει τη συμβολοσειριακή αναπαράσταση του αποτελέσματος.
public string Text { get; }
Τιμή Ιδιότητας
string
Μεθόδοι
ΓιαΑρχείο()
Προσπαθεί να μετατρέψει το αποτέλεσμα σε αρχείο.
Επιστρέφει
string : Μια συμβολοσειρά που αναπαριστά τη διαδρομή προς το αρχείο εξόδου αν το αποτέλεσμα είναι αρχείο; διαφορετικά null
.
ΓιαΡεύμα()
Προσπαθεί να μετατρέψει το αποτέλεσμα σε αντικείμενο ρεύματος.
Επιστρέφει
Stream : Ένα αντικείμενο ρεύματος που αναπαριστά τα δεδομένα εξόδου αν το αποτέλεσμα είναι ρεύμα; διαφορετικά null
.
ΓιαΣυμβολοσειρά()
Προσπαθεί να μετατρέψει το αποτέλεσμα σε συμβολοσειρά.
public override string ToString()
Επιστρέφει
string : Μια συμβολοσειρά που αναπαριστά το περιεχόμενο κειμένου αν το αποτέλεσμα είναι συμβολοσειρά; διαφορετικά επιστρέφει base.ToString().
Αποτέλεσμα Αρχείου
Info
Αναπαριστά το αποτέλεσμα της λειτουργίας με τη μορφή συμβολοσειράς που δείχνει σε αρχείο.
public sealed class FileResult : IOperationResult
Κληρονομικότητα
object ←
FileResult
Υλοποιεί
Κληρονομούμενα μέλη
Ιδιότητες
Δεδομένα
Λαμβάνει ακατέργαστα δεδομένα.
public object Data { get; }
Τιμή Ιδιότητας
object
IsFile
Δείχνει εάν το αποτέλεσμα είναι μια διαδρομή σε ένα αρχείο εξόδου.
public bool IsFile { get; }
Τιμή Ιδιότητας
bool
IsStream
Δείχνει εάν το αποτέλεσμα είναι μια ροή εξόδου.
public bool IsStream { get; }
Τιμή Ιδιότητας
bool
IsString
Δείχνει εάν το αποτέλεσμα είναι μια συμβολοσειρά κειμένου.
public bool IsString { get; }
Τιμή Ιδιότητας
bool
Μέθοδοι
ToFile()
Προσπαθεί να μετατρέψει το αποτέλεσμα σε ένα αρχείο.
Επιστρέφει
string : Μια συμβολοσειρά που αναπαριστά τη διαδρομή προς το αρχείο εξόδου αν το αποτέλεσμα είναι αρχείο; διαφορετικά null
.
ToStream()
Προσπαθεί να μετατρέψει το αποτέλεσμα σε ένα αντικείμενο ροής.
Επιστρέφει
Stream : Ένα αντικείμενο ροής που αναπαριστά τα δεδομένα εξόδου αν το αποτέλεσμα είναι ροή; διαφορετικά null
.
Ασφάλεια Κατηγορίας
Info
Αναπαριστά το πρόσθετο Documentize.Security.
public sealed class Security
Κληρονομικότητα
object ←
Security
Κληρονομούμενα Μέλη
Παραδείγματα
Το παράδειγμα δείχνει πώς να κρυπτογραφήσετε έγγραφο PDF.
// δημιουργία Ασφάλειας
var plugin = new Security();
// δημιουργία αντικειμένου EncryptionOptions για να οριστούν οι οδηγίες
var opt = new EncryptionOptions("123456", "qwerty");
// προσθήκη διαδρομής αρχείου εισόδου
opt.AddInput(new FileDataSource(inputPath));
// ορισμός διαδρομής αρχείου εξόδου
opt.AddOutput(new FileDataSource(outputPath));
// εκτέλεση της διαδικασίας
plugin.Process(opt);
Το παράδειγμα δείχνει πώς να αποκρυπτογραφήσετε έγγραφο PDF.
// δημιουργία Ασφάλειας
var plugin = new Security();
// δημιουργία αντικειμένου DecryptionOptions για να οριστούν οι οδηγίες
var opt = new DecryptionOptions("123456"));
// προσθήκη διαδρομής αρχείου εισόδου
opt.AddInput(new FileDataSource(inputPath));
// ορισμός διαδρομής αρχείου εξόδου
opt.AddOutput(new FileDataSource(outputPath));
// εκτέλεση της διαδικασίας
plugin.Process(opt);
Κατασκευαστές
Security()
Μέθοδοι
Process(IPluginOptions)
Αρχίζει τη διαδικασία Documentize.Security με τις καθορισμένες παραμέτρους.
public ResultContainer Process(IPluginOptions options)
Παράμετροι
options
IPluginOptions: Ένα αντικείμενο επιλογών που περιέχει οδηγίες για την Documentize.Security.
Επιστρέφει
ResultContainer : Ένα αντικείμενο ResultContainer που περιέχει το αποτέλεσμα της λειτουργίας.
Εξαιρέσεις
InvalidOperationException
Βελτιστοποιητής Κλάσης
Info
Αναπαριστά το plugin Documentize.Optimizer.
public sealed class Optimizer
Κληρονομικότητα
object ←
Optimizer
Κληρονομούμενα Μέλη
Παραδείγματα
Το παράδειγμα δείχνει πώς να βελτιστοποιήσετε ένα PDF έγγραφο.
// create Optimizer
var plugin = new Optimizer();
// create OptimizeOptions object to set instructions
var opt = new OptimizeOptions();
// add input file path
opt.AddInput(new FileDataSource(inputPath));
// set output file path
opt.AddOutput(new FileDataSource(outputPath));
// perform the process
plugin.Process(opt);
Κατασκευαστές
Optimizer()
Μέθοδοι
Process(OptimizeOptions)
Ξεκινά τη διαδικασία Documentize.Optimizer με τις καθορισμένες παραμέτρους.
public ResultContainer Process(OptimizeOptions options)
Παράμετροι
options
OptimizeOptions: Ένα αντικείμενο επιλογών που περιέχει οδηγίες για το Documentize.OptimizeOptions.
Επιστρέφει
ResultContainer : Ένα αντικείμενο ResultContainer που περιέχει το αποτέλεσμα της λειτουργίας.
Process(RotateOptions)
Ξεκινά τη διαδικασία Documentize.Optimizer με τις καθορισμένες παραμέτρους.
public ResultContainer Process(RotateOptions options)
Παράμετροι
options
RotateOptions: Ένα αντικείμενο επιλογών που περιέχει οδηγίες για το Documentize.RotateOptions.
Επιστρέφει
ResultContainer : Ένα αντικείμενο ResultContainer που περιέχει το αποτέλεσμα της λειτουργίας.
Process(ResizeOptions)
Ξεκινά τη διαδικασία Documentize.Optimizer με τις καθορισμένες παραμέτρους.
public ResultContainer Process(ResizeOptions options)
Παράμετροι
options
ResizeOptions: Ένα αντικείμενο επιλογών που περιέχει οδηγίες για το Documentize.ResizeOptions.
Επιστρέφει
ResultContainer : Ένα αντικείμενο ResultContainer που περιέχει το αποτέλεσμα της λειτουργίας.
Process(CompressOptions)
Ξεκινά τη διαδικασία Documentize.Optimizer με τις καθορισμένες παραμέτρους.
public ResultContainer Process(CompressOptions options)
Παράμετροι
options
CompressOptions: Ένα αντικείμενο επιλογών που περιέχει οδηγίες για το Documentize.CompressOptions.
Επιστρέφει
ResultContainer : Ένα αντικείμενο ResultContainer που περιέχει το αποτέλεσμα της λειτουργίας.
ΔInterface IPluginOptions
Info
Γενική διεπαφή επιλογών πρόσθετου που ορίζει κοινές μεθόδους που θα πρέπει να υλοποιούν οι συγκεκριμένες επιλογές πρόσθετου.
public interface IPluginOptions
ΔInternational IOperationResult
Info
Γενική διεπαφή αποτελέσματος που ορίζει κοινές μεθόδους που πρέπει να υλοποιεί το συγκεκριμένο αποτέλεσμα λειτουργίας πρόσθετου.
public interface IOperationResult
Ιδιότητες
Data
Αποκτά ακατέργαστα δεδομένα.
Τιμή Ιδιότητας
object
IsFile
Υποδεικνύει εάν το αποτέλεσμα είναι μια διαδρομή σε ένα αρχείο εξόδου.
Τιμή Ιδιότητας
bool
IsStream
Υποδεικνύει εάν το αποτέλεσμα είναι μια ροή εξόδου.
Τιμή Ιδιότητας
bool
IsString
Υποδεικνύει εάν το αποτέλεσμα είναι μια συμβολοσειρά κειμένου.
Τιμή Ιδιότητας
bool
Μέθοδοι
ToFile()
Προσπαθεί να μετατρέψει το αποτέλεσμα σε αρχείο.
Επιστρέφει
string : Μια συμβολοσειρά που αντιπροσωπεύει τη διαδρομή προς το αρχείο εξόδου αν το αποτέλεσμα είναι αρχείο; διαφορετικά null
.
ToStream()
Προσπαθεί να μετατρέψει το αποτέλεσμα σε αντικείμενο ροής.
Επιστρέφει
Stream : Ένα αντικείμενο ροής που αντιπροσωπεύει τα δεδομένα εξόδου αν το αποτέλεσμα είναι ροή; διαφορετικά null
.
Διαχωριστής Κατηγορίας
Info
Αντιπροσωπεύει το plugin Documentize.Splitter. Χρησιμοποιείται για να διαχωρίσει έγγραφα σε ξεχωριστές σελίδες.
Κληρονομικότητα
object ←
Splitter
Κληρονομούμενα Μέλη
Παραδείγματα
Το παράδειγμα δείχνει πώς να διαχωρίσετε ένα έγγραφο PDF.
// δημιουργία του Splitter
var plugin = new Splitter();
// δημιουργία του αντικειμένου SplitOptions για να ορίσετε οδηγίες
var opt = new SplitOptions();
// προσθήκη διαδρομής εισόδου
opt.AddInput(new FileDataSource(inputPath));
// ορισμός διαδρομών εξόδου
opt.AddOutput(new FileDataSource(outputPath1));
opt.AddOutput(new FileDataSource(outputPath2));
// εκτέλεση της διαδικασίας
plugin.Process(opt);
Κατασκευαστές
Splitter()
Μέθοδοι
Process(IPluginOptions)
Αρχίζει τη διαδικασία Documentize.Splitter με τις καθορισμένες παραμέτρους.
public ResultContainer Process(IPluginOptions options)
Παράμετροι
options
IPluginOptions: Ένα αντικείμενο επιλογών που περιέχει οδηγίες για το Documentize.Splitter.
Επιστρέφει
ResultContainer : Ένα αντικείμενο ResultContainer που περιέχει το αποτέλεσμα της λειτουργίας.
Εξαιρέσεις
InvalidOperationException
Διαχωριστικές Επιλογές Κατηγορίας
Info
Αναπαριστά τις Διαχωριστικές επιλογές για το plugin Documentize.Splitter.
public sealed class SplitOptions : PluginBaseOptions, IPluginOptions
Κληρονομικότητα
object ←
PluginBaseOptions ←
SplitOptions
Υλοποιεί
Κληρονομούμενα Μέλη
- 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()
Κατασκευαστές
SplitOptions()
Αρχικοποιεί μια νέα παρουσία του αντικειμένου Documentize.SplitOptions με προεπιλεγμένες επιλογές.
Διεπαφή IDataSource
Info
Γενική διεπαφή δεδομένων που ορίζει κοινά μέλη που θα πρέπει να υλοποιούν τα συγκεκριμένα δεδομένα.
public interface IDataSource
Properties
DataType
Τύπος πηγής δεδομένων.
DataType DataType { get; }
Property Value
DataType
ΔιεύθυνσηΔεδομένωνΤάξης
Info
Αναπαριστά δεδομένα καταλόγου για λειτουργίες φόρτωσης και αποθήκευσης ενός πρόσθετου.
public sealed class DirectoryDataSource : IDataSource
Κληρονομία
object ←
DirectoryDataSource
Υλοποιεί
Κληρονομούμενα Μέλη
Κατασκευαστές
DirectoryDataSource(string)
Αρχικοποιεί νέα δεδομένα καταλόγου με τη συγκεκριμένη διαδρομή.
public DirectoryDataSource(string path)
Παράμετροι
path
string: Μια συμβολοσειρά που αναπαριστά τη διαδρομή προς τον κατάλογο.
Ιδιότητες
DataType
Τύπος πηγής δεδομένων.
public DataType DataType { get; }
Τιμή Ιδιότητας
DataType
Path
Ανάκτηση της διαδρομής προς τον κατάλογο των τρεχόντων δεδομένων.
public string Path { get; }
Τιμή Ιδιότητας
string
Εκδότης Εικόνας
Info
Αναπαριστά το plugin Documentize.ImageExtractor. Χρησιμοποιείται για την εξαγωγή εικόνων από έγγραφα PDF.
public class ImageExtractor : PdfExtractor, IDisposable
Κληρονομικότητα
object ←
PdfExtractor ←
ImageExtractor
Υλοποιεί
Κληρονομούμενα Μέλη
- PdfExtractor.Process(IPluginOptions),
- PdfExtractor.Dispose(),
- object.GetType(),
- object.MemberwiseClone(),
- object.ToString(),
- object.Equals(object?),
- object.Equals(object?, object?),
- object.ReferenceEquals(object?, object?),
- object.GetHashCode()
Παραδείγματα
Το παράδειγμα δείχνει πώς να εξάγεται εικόνες από έγγραφο PDF.
// create ImageExtractor object to extract images
using (var plugin = new ImageExtractor())
{
// create ImageExtractorOptions
var opt = new ImageExtractorOptions();
// add input file path
opt.AddInput(new FileDataSource(inputPath));
// set output directory
opt.AddInput(new FileDataSource("D:\\"));
// perform extraction process
var resultContainer = plugin.Process(opt);
// get the image from the ResultContainer object
var imageExtracted = resultContainer.ResultCollection[0].ToFile();
}
Κατασκευαστές
Επιλογές Αλλαγής Μεγέθους Κλάσης
Info
Αναπαριστά τις επιλογές αλλαγής μεγέθους για το plugin Documentize.Optimizer.
public sealed class ResizeOptions : PluginBaseOptions, IPluginOptions
Κληρονομικότητα
object ←
PluginBaseOptions ←
ResizeOptions
Υλοποιεί
Κληρονομούμενα Μέλη
- 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()
Κατασκευαστές
ResizeOptions()
Αρχικοποιεί μια νέα παρουσία του αντικειμένου Documentize.ResizeOptions με προεπιλεγμένες επιλογές.
Ιδιότητες
PageSize
Αποκτά ή ορίζει το νέο μέγεθος σελίδας.
public PageSize PageSize { get; set; }
Αξία Ιδιότητας
PageSize
Επιλογές Αφαιρέτη Εικόνας Κλάσης
Info
Αναπαριστά τις επιλογές εξαγωγής εικόνων για το πρόσθετο Documentize.ImageExtractor.
public sealed class ImageExtractorOptions : PdfExtractorOptions, IPluginOptions
Κληρονομικότητα
object ←
PdfExtractorOptions ←
ImageExtractorOptions
Υλοποιήσεις
Κληρονομούμενα Μέλη
- PdfExtractorOptions.AddInput(IDataSource),
- PdfExtractorOptions.Inputs,
- PdfExtractorOptions.OperationName,
- object.GetType(),
- object.ToString(),
- object.Equals(object?),
- object.Equals(object?, object?),
- object.ReferenceEquals(object?, object?),
- object.GetHashCode()
Παρατηρήσεις
Κληρονομεί λειτουργίες για την προσθήκη δεδομένων (αρχείων, ροών) που αναπαριστούν έγγραφα PDF εισόδου.
Κατασκευαστές
Αρχικοποιεί μια νέα περίσταση του αντικειμένου Documentize.ImageExtractorOptions.
public ImageExtractorOptions()
Ιδιότητες
Επιστρέφει το όνομα της λειτουργίας.
public override string OperationName { get; }
Τιμή Ιδιότητας
string
Επιλογές Πίνακα
Info
Αναπαριστά τις επιλογές για την προσθήκη πίνακα στο έγγραφο μέσω του plugin Documentize.TableGenerator.
public sealed class TableOptions : PluginBaseOptions, IPluginOptions
Κληρονομικότητα
object ←
PluginBaseOptions ←
TableOptions
Υλοποιεί
Κληρονομούμενα μέλη
- 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()
Κατασκευαστές
TableOptions()
Αρχικοποιεί νέα παρουσία του αντικειμένου Documentize.TableOptions με προεπιλεγμένες επιλογές.
Μέθοδοι
AddTable()
Προσθήκη πίνακα στο έγγραφο.
public TableBuilder AddTable()
Επιστρέφει
TableBuilder : Νέα παρουσία του Documentize.TableBuilder.
Create()
Δημιουργία παρουσίας του Documentize.TableOptions.
public static TableOptions Create()
Επιστρέφει
TableOptions : Νέα παρουσία του Documentize.TableOptions.
InsertPageAfter(int)
Εισαγωγή σελίδας μετά την καθορισμένη σελίδα.
public TableOptions InsertPageAfter(int page)
Παράμετροι
page
int: Αριθμός σελίδας μετά την οποία θα εισαχθεί ο πίνακας.
Επιστρέφει
TableOptions : Παρουσία της τρέχουσας Documentize.TableOptions.
InsertPageBefore(int)
Εισαγωγή σελίδας πριν από την καθορισμένη σελίδα.
public TableOptions InsertPageBefore(int page)
Παράμετροι
page
int: Αριθμός σελίδας πριν από την οποία θα εισαχθεί ο πίνακας.
Επιστρέφει
TableOptions : Παρουσία της τρέχουσας Documentize.TableOptions.
Επιλογές Συγχώνευσης Κλάσης
Info
Αντιπροσωπεύει τις επιλογές συγχώνευσης για το plugin Documentize.Merger.
public sealed class MergeOptions : PluginBaseOptions, IPluginOptions
Κληρονομικότητα
object ←
PluginBaseOptions ←
MergeOptions
Υλοποιεί
Κληρονομούμενα Μέλη
- 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()
Κατασκευαστές
MergeOptions()
Αρχικοποιεί μια νέα παρουσία του αντικειμένου Documentize.MergeOptions με προεπιλεγμένες επιλογές.
Επιλογές Υπογραφής Κατηγορίας
Info
Αναπαριστά τις Επιλογές Υπογραφής για το πρόσθετο Documentize.Signature.
public sealed class SignOptions : PluginBaseOptions, IPluginOptions
Κληρονομιά
object ←
PluginBaseOptions ←
SignOptions
Υλοποιεί
Κληρονομημένα Μέλη
- 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()
Κατασκευαστές
SignOptions(string, string)
Αρχικοποιεί νέα έκδοση του αντικειμένου Documentize.SignOptions με προεπιλεγμένες επιλογές.
public SignOptions(string pfx, string password)
Παράμετροι
pfx
string: Η διαδρομή προς το αρχείο pfx.password
string: Ο κωδικός πρόσβασης για το αρχείο pfx.
SignOptions(Stream, string)
Αρχικοποιεί νέα έκδοση του αντικειμένου Documentize.SignOptions με προεπιλεγμένες επιλογές.
public SignOptions(Stream pfx, string password)
Παράμετροι
pfx
Stream: Ο ροής με το αρχείο pfx.password
string: Ο κωδικός πρόσβασης για το αρχείο pfx.
Ιδιότητες
Η επαφή της υπογραφής.
public string Contact { get; set; }
Τιμή Ιδιότητας
string
Τοποθεσία
Η τοποθεσία της υπογραφής.
public string Location { get; set; }
Τιμή Ιδιότητας
string
Όνομα
Το όνομα του υπάρχοντος πεδίου υπογραφής.
Null για να δημιουργήσετε ένα νέο πεδίο.
public string Name { get; set; }
Τιμή Ιδιότητας
string
Αριθμός Σελίδας
Ο αριθμός σελίδας στην οποία πραγματοποιείται η υπογραφή.
public int PageNumber { get; set; }
Τιμή Ιδιότητας
int
Λόγος
Ο λόγος της υπογραφής.
public string Reason { get; set; }
Τιμή Ιδιότητας
string
Ορθογώνιο
Το ορθογώνιο της υπογραφής.
public Rectangle Rectangle { get; set; }
Τιμή Ιδιότητας
Rectangle
Ορατό
Η ορατότητα της υπογραφής.
public bool Visible { get; set; }
Τιμή Ιδιότητας
bool
Κατασκευαστής Πίνακα Γραμμής
Info
Η κλάση αντιπροσωπεύει τον κατασκευαστή για γραμμή πίνακα.
public class TableRowBuilder : TableBuilder
Κληρονομικότητα
object ←
TableBuilder ←
TableRowBuilder
Παράγωγοι
Κληρονομούμενα Μέλη
- TableBuilder.AddRow(),
- TableBuilder.AddTable(),
- TableBuilder.InsertPageAfter(int),
- TableBuilder.InsertPageBefore(int),
- object.GetType(),
- object.MemberwiseClone(),
- object.ToString(),
- object.Equals(object?),
- object.Equals(object?, object?),
- object.ReferenceEquals(object?, object?),
- object.GetHashCode()
Μέθοδοι
AddCell()
Προσθήκη κελιού στη γραμμή πίνακα.
public virtual TableCellBuilder AddCell()
Επιστρέφει
TableCellBuilder : Αντίγραφο του δημιουργούμενου Documentize.TableCellBuilder.
AddRow()
Υπερκαλύπτοντας την AddRow.
public override TableRowBuilder AddRow()
Επιστρέφει
TableRowBuilder : Αντίγραφο του τρέχοντος Documentize.TableRowBuilder.
Κατηγορία DecryptionOptions
Info
Αναπαριστά τις Επιλογές Αποκρυπτογράφησης για το plugin Documentize.Security.
public class DecryptionOptions : PluginBaseOptions, IPluginOptions
Κληρονομικότητα
object ←
PluginBaseOptions ←
DecryptionOptions
Υλοποιεί
Κληρονομούμενα Μέλη
- 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()
Κατασκευαστές
DecryptionOptions(string)
Αρχικοποιεί μια νέα instance του αντικειμένου Documentize.DecryptionOptions με προεπιλεγμένες επιλογές.
public DecryptionOptions(string ownerPassword)
Παράμετροι
ownerPassword
string: Κωδικός πρόσβασης ιδιοκτήτη.
Ιδιότητες
OwnerPassword
Κωδικός πρόσβασης ιδιοκτήτη.
public string OwnerPassword { get; set; }
Τιμή Ιδιότητας
string
Κατηγορία FileDataSource
Info
Αναπαριστά τα δεδομένα αρχείου για λειτουργίες φόρτωσης και αποθήκευσης ενός πρόσθετου.
public sealed class FileDataSource : IDataSource
Κληρονομικότητα
object ←
FileDataSource
Υλοποιεί
Κληρονομημένα Μέλη
Κατασκευαστές
FileDataSource(string)
Αρχικοποιεί νέα πηγή δεδομένων αρχείου με την καθορισμένη διαδρομή.
public FileDataSource(string path)
Παράμετροι
path
string: Μια συμβολοσειρά που αναπαριστά τη διαδρομή προς το αρχείο πηγής.
Ιδιότητες
DataType
Τύπος πηγής δεδομένων.
public DataType DataType { get; }
Τιμή Ιδιότητας
DataType
Path
Λαμβάνει τη διαδρομή προς το αρχείο των τρεχουσών δεδομένων.
public string Path { get; }
Τιμή Ιδιότητας
string
Κατηγορία HtmlToPdfOptions
Info
Αναπαριστά τις επιλογές μετατροπής HTML σε PDF για το plugin Documentize.HtmlConverter.
public sealed class HtmlToPdfOptions : PluginBaseOptions, IPluginOptions
Κληρονομικότητα
object ←
PluginBaseOptions ←
HtmlToPdfOptions
Υλοποιεί
Κληρονομούμενα Μέλη
- 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()
Κατασκευαστές
HtmlToPdfOptions()
Αρχικοποιεί μια νέα εμφάνιση του αντικειμένου Documentize.HtmlToPdfOptions.
public HtmlToPdfOptions()
Ιδιότητες
BasePath
Η βασική διαδρομή/διεύθυνση URL για το αρχείο html.
public string BasePath { get; set; }
Τιμή Ιδιότητας
string
Ανακτά ή ορίζει τους πιθανούς τύπους μέσων που χρησιμοποιούνται κατά τη διάρκεια της απεικόνισης.
public HtmlMediaType HtmlMediaType { get; set; }
Τιμή Ιδιότητας
HtmlMediaType
IsRenderToSinglePage
Ανακτά ή ορίζει την απεικόνιση ολόκληρου του εγγράφου σε μία σελίδα.
public bool IsRenderToSinglePage { get; set; }
Τιμή Ιδιότητας
bool
PageInfo
Ανακτά ή ορίζει τις πληροφορίες σελίδας του εγγράφου.
public PageInfo PageInfo { get; set; }
Τιμή Ιδιότητας
PageInfo
PageLayoutOption
Ανακτά ή ορίζει την επιλογή διάταξης.
public HtmlPageLayoutOption PageLayoutOption { get; set; }
Τιμή Ιδιότητας
HtmlPageLayoutOption
Κατηγορία OptimizeOptions
Info
Αναπαριστά τις επιλογές Optimize για το plugin Documentize.Optimizer.
public sealed class OptimizeOptions : PluginBaseOptions, IPluginOptions
Κληρονομικότητα
object ←
PluginBaseOptions ←
OptimizeOptions
Υλοποιεί
Κληρονομούμενα Μέλη
- 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()
Κατασκευαστές
OptimizeOptions()
Εκκινεί μια νέα εκδοχή του αντικειμένου Documentize.OptimizeOptions με προεπιλεγμένες επιλογές.
Ευθυγραμμίζει το έγγραφο προκειμένου να
- ανοίξει την πρώτη σελίδα όσο το δυνατόν γρηγορότερα;
- εμφανίσει την επόμενη σελίδα ή να ακολουθήσει μέσω συνδέσμου την επόμενη σελίδα όσο το δυνατόν γρηγορότερα;
- εμφανίζει τη σελίδα σταδιακά καθώς φτάνει όταν τα δεδομένα για μια σελίδα παραδίδονται μέσω ενός αργού καναλιού (εμφάνιση των πιο χρήσιμων δεδομένων πρώτα);
- επιτρέπει την αλληλεπίδραση του χρήστη, όπως η ακολουθία ενός συνδέσμου, να πραγματοποιείται ακόμα και πριν ληφθεί και εμφανιστεί ολόκληρη η σελίδα.
Κατηγορία PdfAOptionsBase
Info
Αντιπροσωπεύει την базовую класс για τις επιλογές του plugin Documentize.PdfAConverter. Αυτή η κλάση παρέχει ιδιότητες και μεθόδους για τη ρύθμιση της διαδικασίας μετατροπής και επικύρωσης PDF/A.
Αντιπροσωπεύει την базовую класс για τις επιλογές του plugin Documentize.PdfAConverter.
Αυτή η κλάση παρέχει ιδιότητες και μεθόδους για τη ρύθμιση της διαδικασίας μετατροπής και επικύρωσης PDF/A.
public abstract class PdfAOptionsBase : IPluginOptions
Κληρονομικότητα
object ←
PdfAOptionsBase
Παράγωγες
Υλοποιεί
Κληρονομημένα Μέλη
Κατασκευαστές
PdfAOptionsBase()
protected PdfAOptionsBase()
Ιδιότητες
AlignText
Λαμβάνει ή ορίζει μια τιμή που υποδεικνύει αν είναι απαραίτητοι επιπλέον τρόποι για να διατηρηθεί η ευθυγράμμιση του κειμένου κατά τη διαδικασία μετατροπής PDF/A.
public bool AlignText { get; set; }
Τιμή Ιδιοτήτων
bool
Παρατηρήσεις
Όταν οριστεί σε true, η διαδικασία μετατροπής θα προσπαθήσει να αποκαταστήσει τα αρχικά όρια τμημάτων κειμένου.
Για τους περισσότερους από τους εγγράφους δεν υπάρχει ανάγκη να αλλάξετε αυτή την ιδιότητα από την προεπιλεγμένη false τιμή,
καθώς η ευθυγράμμιση του κειμένου δεν αλλάζει κατά τη διάρκεια της προεπιλεγμένης διαδικασίας μετατροπής.
CheckDifferentNamesInFontDictionaries
Λαμβάνει τις σημαίες που ελέγχουν τη μετατροπή PDF/A σε περιπτώσεις όπου το πηγαίο έγγραφο PDF δεν
αντιστοιχεί στη спецификация PDF.
public bool CheckDifferentNamesInFontDictionaries { get; set; }
Τιμή Ιδιοτήτων
bool
ErrorAction
Λαμβάνει ή ορίζει την ενέργεια που θα ληφθεί για αντικείμενα που δεν μπορούν να μετατραπούν.
public ConvertErrorAction ErrorAction { get; set; }
Τιμή Ιδιοτήτων
ConvertErrorAction
IccProfileFileName
Λαμβάνει ή ορίζει το όνομα αρχείου του προφίλ ICC (Διεθνής Συνομοσπονδία Χρώματος) που θα χρησιμοποιηθεί για τη μετατροπή PDF/A αντί του προεπιλεγμένου.
public string IccProfileFileName { get; set; }
Τιμή Ιδιοτήτων
string
Λαμβάνει συλλογή πηγών δεδομένων
public List<idatasource> Inputs { get; }
Τιμή Ιδιοτήτων
List<IDataSource>
IsLowMemoryMode
Λαμβάνει ή ορίζει μια τιμή που υποδεικνύει αν είναι ενεργοποιημένη η λειτουργία χαμηλής μνήμης κατά τη διαδικασία μετατροπής PDF/A.
public bool IsLowMemoryMode { get; set; }
Τιμή Ιδιοτήτων
bool
LogOutputSource
Λαμβάνει ή ορίζει την πηγή δεδομένων για την έξοδο καταγραφής.
public IDataSource LogOutputSource { get; set; }
Τιμή Ιδιοτήτων
IDataSource
OptimizeFileSize
Λαμβάνει ή ορίζει μια τιμή που υποδεικνύει αν θα προσπαθήσει να μειώσει το μέγεθος του αρχείου κατά τη διαδικασία μετατροπής PDF/A.
public bool OptimizeFileSize { get; set; }
Τιμή Ιδιοτήτων
bool
Παρατηρήσεις
Όταν οριστεί σε true, η διαδικασία μετατροπής θα προσπαθήσει να ελαχιστοποιήσει το μέγεθος του παραγόμενου αρχείου.
Αυτό μπορεί να επηρεάσει την απόδοση της διαδικασίας μετατροπής.
PdfAVersion
Λαμβάνει ή ορίζει την έκδοση του προτύπου PDF/A που θα χρησιμοποιηθεί για την επικύρωση ή τη μετατροπή.
public PdfAStandardVersion PdfAVersion { get; set; }
Τιμή Ιδιοτήτων
PdfAStandardVersion
Παρατηρήσεις
Η έκδοση προτύπου PDF/A χρησιμοποιείται για να καθορίσει το επίπεδο συμμόρφωσης για την επικύρωση και τη μετατροπή PDF/A.
Εάν η έκδοση οριστεί σε Documentize.PdfAStandardVersion.Auto, το σύστημα θα προσδιορίσει αυτόματα
την αντίστοιχη έκδοση προτύπου PDF/A για την επικύρωση με βάση τα μεταδεδομένα του εγγράφου.
Για τη διαδικασία μετατροπής PDF/A, η Documentize.PdfAStandardVersion.Auto προεπιλέγει την έκδοση προτύπου PDF/A-1b.
SoftMaskAction
Λαμβάνει ή ορίζει την ενέργεια που θα ληφθεί κατά τη διαδικασία μετατροπής εικόνων με μαλακά μάσκες.
public ConvertSoftMaskAction SoftMaskAction { get; set; }
Τιμή Ιδιοτήτων
ConvertSoftMaskAction
Μέθοδοι
Προσθέτει νέα πηγή δεδομένων στη συλλογή
public void AddInput(IDataSource dataSource)
Παράμετροι
Κατηγορία PdfChatGpt
Info
Αναπαριστά το plugin PdfChatGpt.
public sealed class PdfChatGpt : IDisposable
Κληρονομιά
object ←
PdfChatGpt
Υλοποιεί
Κληρονομούμενα Μέλη
Παραδείγματα
Το παράδειγμα δείχνει πώς να χρησιμοποιήσετε το plugin PdfChatGpt προσθέτοντας μηνύματα στο αίτημα.
using (var plugin = new PdfChatGpt())
{
var options = new PdfChatGptRequestOptions();
options.AddOutput(new FileDataSource("PdfChatGPT_output.pdf")); // Προσθέστε τη διαδρομή εξόδου αρχείου.
options.ApiKey = "Το API key σας."; // Πρέπει να δώσετε το κλειδί για να αποκτήσετε πρόσβαση στο API.
options.MaxTokens = 1000; // Ο μέγιστος αριθμός tokens που θα παραχθούν στην ολοκλήρωση της συνομιλίας.
// Προσθέστε τα μηνύματα του αιτήματος.
options.Messages.Add(new Message
{
Content = "Είστε ένας χρήσιμος βοηθός.",
Role = Role.System
});
options.Messages.Add(new Message
{
Content = "Ποια είναι η μεγαλύτερη διάμετρος πίτσας που έχει φτιαχτεί ποτέ;",
Role = Role.User
});
// Επεξεργαστείτε το αίτημα.
var result = await plugin.ProcessAsync(options);
var fileResultPath = result.ResultCollection[0].Data;
var chatCompletionObject = result.ResultCollection[1].Data as ChatCompletion; // Το αντικείμενο ολοκλήρωσης συνομιλίας του API ChatGPT.
}
Το παράδειγμα δείχνει πώς να χρησιμοποιήσετε το plugin PdfChatGpt προσθέτοντας ένα μήνυμα στο αίτημα.
using (var plugin = new PdfChatGpt())
{
var options = new PdfChatGptRequestOptions();
options.AddOutput(new FileDataSource("PdfChatGPT_output.pdf")); // Προσθέστε τη διαδρομή εξόδου αρχείου.
options.ApiKey = "Το API key σας."; // Πρέπει να δώσετε το κλειδί για να αποκτήσετε πρόσβαση στο API.
options.MaxTokens = 1000; // Ο μέγιστος αριθμός tokens που θα παραχθούν στην ολοκλήρωση της συνομιλίας.
// Προσθέστε το μήνυμα του αιτήματος.
// Σε αυτή την περίπτωση, το σύστημα μήνυμα με Content = "Είστε ένας χρήσιμος βοηθός." προστίθεται από προεπιλογή.
// Ο ρόλος του μήνυματος ερώτησης είναι "χρήστης" από προεπιλογή.
options.Query = "Ποια είναι η χαμηλότερη θερμοκρασία που έχει καταγραφεί στη Γη;";
// Επεξεργαστείτε το αίτημα.
var result = await plugin.ProcessAsync(options);
var fileResultPath = result.ResultCollection[0].Data;
var chatCompletionObject = result.ResultCollection[1].Data as ChatCompletion; // Το αντικείμενο ολοκλήρωσης συνομιλίας του API ChatGPT.
}
Το παράδειγμα δείχνει πώς να χρησιμοποιήσετε το plugin PdfChatGpt προσθέτοντας αρχεία ως πηγές μηνυμάτων.
using (var plugin = new PdfChatGpt())
{
var options = new PdfChatGptRequestOptions();
options.AddOutput(new FileDataSource("PdfChatGPT_output.pdf")); // Προσθέστε τη διαδρομή εξόδου αρχείου.
// Προσθέστε την πηγή κειμένου PDF.
// Σε περίπτωση πολλαπλών πηγών, το κείμενο από κάθε έγγραφο θα προστεθεί στη συλλογή μηνυμάτων αιτήματος
// ως ξεχωριστό μήνυμα με τον ρόλο "χρήστη".
options.AddInput(new FileDataSource("TextSource.pdf"));
options.ApiKey = "Το API key σας."; // Πρέπει να δώσετε το κλειδί για να αποκτήσετε πρόσβαση στο API.
options.MaxTokens = 1000; // Ο μέγιστος αριθμός tokens που θα παραχθούν στην ολοκλήρωση της συνομιλίας.
// Προσθέστε το μήνυμα του αιτήματος.
// Σε αυτή την περίπτωση, το σύστημα μήνυμα με Content = "Είστε ένας χρήσιμος βοηθός." προστίθεται από προεπιλογή.
// Ο ρόλος του μήνυματος ερώτησης είναι "χρήστης" από προεπιλογή.
options.Query = "Πόσα γράμματα υπάρχουν στο παρεχόμενο κείμενο;";
// Επεξεργαστείτε το αίτημα.
var result = await plugin.ProcessAsync(options);
var fileResultPath = result.ResultCollection[0].Data;
var chatCompletionObject = result.ResultCollection[1].Data as ChatCompletion; // Το αντικείμενο ολοκλήρωσης συνομιλίας του API ChatGPT.
}
Παρατηρήσεις
Το αντικείμενο Documentize.PdfChatGpt χρησιμοποιείται για την αποστολή αιτημάτων στο ChatGPT απευθείας
ή προσθέτοντας πηγές αρχείου PDF και αποθηκεύει την απάντηση στην έξοδο πηγή.
Κατασκευαστές
PdfChatGpt()
Αρχικοποιεί μια νέα παρουσία του αντικειμένου Documentize.PdfChatGpt.
Μέθοδοι
Dispose()
Υλοποίηση του IDisposable. Στην πραγματικότητα, δεν είναι απαραίτητο για το PdfChatGpt.
Process(IPluginOptions)
Η μέθοδος δεν έχει συγχρονισμένη έκδοση. Χρησιμοποιήστε τη μέθοδο ProcessAsync αντί.
public ResultContainer Process(IPluginOptions options)
Παράμετροι
options
IPluginOptions: Ένα αντικείμενο επιλογών που περιέχει οδηγίες για το PdfChatGpt.
Επιστρέφει
ResultContainer : #### Εξαιρέσεις
NotImplementedException
ProcessAsync(IPluginOptions)
Αρχίζει την επεξεργασία PdfChatGpt με τις καθορισμένες παραμέτρους.
public Task<resultcontainer> ProcessAsync(IPluginOptions options)
Παράμετροι
options
IPluginOptions: Ένα αντικείμενο επιλογών που περιέχει οδηγίες για το PdfChatGpt.
Επιστρέφει
Task<ResultContainer>
Το αντικείμενο εργασίας που αναπαριστά τη ασύγχρονη λειτουργία.
Εξαιρέσεις
ArgumentException : InvalidOperationException
SetCancellationToken(CancellationToken)
Ορίζει το token ακύρωσης.
public void SetCancellationToken(CancellationToken cancellationToken)
Παράμετροι
Κατηγορία PdfChatGptOptions
Info
Αναπαριστά επιλογές για το Documentize.PdfChatGpt plugin.
public class PdfChatGptOptions : IPluginOptions
Κληρονομικότητα
object ←
PdfChatGptOptions
Παράγωγα
Υλοποιεί
Κληρονομούμενα Μέλη
Κατασκευαστές
PdfChatGptOptions()
Αρχικοποιεί μια νέα παρουσία του αντικειμένου Documentize.PdfChatGptOptions.
public PdfChatGptOptions()
Ιδιότητες
public List<idatasource> Inputs { get; }
Τιμή Ιδιοτήτων
List<IDataSource>
Outputs
public List<idatasource> Outputs { get; }
Τιμή Ιδιοτήτων
List<IDataSource>
Μέθοδοι
Προσθέτει νέα πηγή δεδομένων στη συλλογή δεδομένων του PdfChatGpt plugin.
public void AddInput(IDataSource dataSource)
Παράμετροι
dataSource
IDataSource: Πηγή δεδομένων (αρχείο ή ροή) προς προσθήκη.
AddOutput(IDataSource)
Προσθέτει νέα πηγή δεδομένων αποθήκευσης στη συλλογή δεδομένων του PdfChatGpt plugin.
public void AddOutput(IDataSource saveDataSource)
Παράμετροι
saveDataSource
IDataSource: Πηγή δεδομένων (αρχείο ή ροή) για αποθήκευση αποτελεσμάτων λειτουργίας. :
Κατηγορία PdfConverterOptions
Info
Αναπαριστά επιλογές για plugins μετατροπέα Pdf.
public abstract class PdfConverterOptions : IPluginOptions
Κληρονομικότητα
object ←
PdfConverterOptions
Παράγωγα
Υλοποιεί
Κληρονομημένα Μέλη
Ιδιότητες
Επιστρέφει τη συλλογή δεδομένων plugin PdfConverterOptions.
public List<idatasource> Inputs { get; }
Τιμή Ιδιότητας
List<IDataSource>
Έξοδοι
Αποκτά τη συλλογή των προστιθέμενων στόχων για την αποθήκευση των αποτελεσμάτων λειτουργίας.
public List<idatasource> Outputs { get; }
Τιμή Ιδιότητας
List<IDataSource>
Μέθοδοι
Προσθέτει νέα πηγή δεδομένων στη συλλογή δεδομένων plugin PdfConverter.
public void AddInput(IDataSource dataSource)
Παράμετροι
AddOutput(IDataSource)
Προσθέτει νέα πηγή δεδομένων στη συλλογή δεδομένων του plugin PdfToXLSXConverterOptions.
public void AddOutput(IDataSource saveDataSource)
Παράμετροι
saveDataSource
IDataSource: Πηγή δεδομένων (αρχείο ή ροή) για την αποθήκευση των αποτελεσμάτων λειτουργίας.
Εξαιρέσεις
NotImplementedException
Κατηγορία PdfToHtmlOptions
Info
Αναπαριστά τις επιλογές μετατροπής PDF σε HTML για το πρόσθετο Documentize.HtmlConverter.
public sealed class PdfToHtmlOptions : PdfConverterOptions, IPluginOptions
Κληρονομικότητα
object ←
PdfConverterOptions ←
PdfToHtmlOptions
Εφαρμόζει
Κληρονομούμενα Μέλη
- 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()
Κατασκευαστές
PdfToHtmlOptions()
Αρχικοποιεί μια νέα παρουσία του αντικειμένου Documentize.PdfToHtmlOptions με προεπιλεγμένες επιλογές.
public PdfToHtmlOptions()
PdfToHtmlOptions(SaveDataType)
Αρχικοποιεί μια νέα παρουσία του αντικειμένου Documentize.PdfToHtmlOptions για τον καθορισμένο τύπο δεδομένων εξόδου.
public PdfToHtmlOptions(PdfToHtmlOptions.SaveDataType outputDataType)
Παράμετροι
Ιδιότητες
OutputDataType
Λαμβάνει τον τύπο δεδομένων εξόδου.
public PdfToHtmlOptions.SaveDataType OutputDataType { get; }
Τιμή Ιδιότητας
PdfToHtmlOptions.SaveDataType
Κατηγορία PdfToJpegOptions
Info
Αναπαριστά τις επιλογές μετατροπής PDF σε JPEG για το plugin Documentize.JpegConverter.
public sealed class PdfToJpegOptions : PluginBaseOptions, IPluginOptions
Κληρονομικότητα
object ←
PluginBaseOptions ←
PdfToJpegOptions
Υλοποιεί
Κληρονομημένα Μέλη
- 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()
Δημιουργοί
PdfToJpegOptions()
Αρχικοποιεί μια νέα παρουσία του αντικειμένου Documentize.PdfToJpegOptions.
public PdfToJpegOptions()
Ιδιότητες
OutputResolution
Παίρνει ή ορίζει την τιμή ανάλυσης των παραγόμενων εικόνων.
public int OutputResolution { get; set; }
Τιμή Ιδιότητας
int
PageList
Παίρνει ή ορίζει μια λίστα σελίδων για τη διαδικασία.
public List<int> PageList { get; set; }
Τιμή Ιδιότητας
List<int>
Quality
Παίρνει και ορίζει την ποιότητα εξόδου.
public int Quality { get; set; }
Τιμή Ιδιότητας
int
Κατηγορία PdfToTiffOptions
Info
Αντιπροσωπεύει τις επιλογές μετατροπής PDF σε TIFF για το plugin Documentize.TiffConverter.
public sealed class PdfToTiffOptions : PluginBaseOptions, IPluginOptions
Κληρονομικότητα
object ←
PluginBaseOptions ←
PdfToTiffOptions
Υλοποιεί
Κληρονομημένα Μέλη
- 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()
Κατασκευαστές
PdfToTiffOptions()
Εκκινεί μια νέα παρουσία του αντικειμένου Documentize.PdfToTiffOptions.
public PdfToTiffOptions()
Ιδιότητες
MultiPage
Ανακτά και ορίζει σημαία που επιτρέπει την αποθήκευση όλων των σελίδων σε ένα multi-page tiff.
public bool MultiPage { get; set; }
Τιμή Ιδιότητας
bool
OutputResolution
Ανακτά ή ορίζει την τιμή ανάλυσης των προκύπτοντων εικόνων.
public int OutputResolution { get; set; }
Τιμή Ιδιότητας
int
PageList
Ανακτά ή ορίζει μια λίστα με σελίδες για τη διαδικασία.
public List<int> PageList { get; set; }
Τιμή Ιδιότητας
List<int>
Κατηγορία PdfToXlsOptions
Info
Αναπαριστά τις επιλογές μετατροπής PDF σε XLSX για το plugin Documentize.XlsConverter.
public sealed class PdfToXlsOptions : PdfConverterOptions, IPluginOptions
Κληρονομικότητα
object ←
PdfConverterOptions ←
PdfToXlsOptions
Υλοποιεί
Κληρονομούμενα Μέλη
- 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()
Κατασκευαστές
PdfToXlsOptions()
Αρχικοποιεί μια νέα κατάσταση του αντικειμένου Documentize.PdfToXlsOptions με προεπιλεγμένες επιλογές.
Ιδιότητες
Μορφή εξόδου.
public PdfToXlsOptions.ExcelFormat Format { get; set; }
Τιμή Ιδιότητας
PdfToXlsOptions.ExcelFormat
InsertBlankColumnAtFirst
Ορίστε true αν χρειάζεστε την εισαγωγή κενής στήλης ως την πρώτη στήλη του φύλλου εργασίας.
Η προεπιλεγμένη τιμή είναι false. Αυτό σημαίνει ότι δεν θα εισαχθεί κενή στήλη.
public bool InsertBlankColumnAtFirst { get; set; }
Τιμή Ιδιότητας
bool
MinimizeTheNumberOfWorksheets
Ορίστε true αν χρειάζεστε να ελαχιστοποιήσετε τον αριθμό των φύλλων εργασίας στο παραγόμενο βιβλίο εργασίας.
Η προεπιλεγμένη τιμή είναι false. Αυτό σημαίνει ότι θα αποθηκευτεί κάθε σελίδα PDF ως χωριστό φύλλο εργασίας.
public bool MinimizeTheNumberOfWorksheets { get; set; }
Τιμή Ιδιότητας
bool
Κατηγορία PluginBaseOptions
Info
Αναπαριστά τις βασικές επιλογές για τα πρόσθετα.
public class PluginBaseOptions : IPluginOptions
Κληρονομικότητα
object ←
PluginBaseOptions
Παράγωγα
- AddTimestampOptions,
- CompressOptions,
- DecryptionOptions,
- EncryptionOptions,
- HtmlToPdfOptions,
- MergeOptions,
- OptimizeOptions,
- PdfToJpegOptions,
- PdfToPngOptions,
- PdfToTiffOptions,
- ResizeOptions,
- RotateOptions,
- SignOptions,
- SplitOptions,
- TableOptions
Εφαρμόζει
Κληρονομημένα Μέλη
Ιδιότητες
Κλείνει τις ροές εισόδου μετά την ολοκλήρωση της διαδικασίας.
public bool CloseInputStreams { get; set; }
Τιμή Ιδιότητας
bool
CloseOutputStreams
Κλείνει τις ροές εξόδου μετά την ολοκλήρωση της διαδικασίας.
public bool CloseOutputStreams { get; set; }
Τιμή Ιδιότητας
bool
Επιστρέφει δεδομένα εισόδων για τη διαδικασία.
public List<idatasource> Inputs { get; }
Τιμή Ιδιότητας
List<IDataSource>
Outputs
Επιστρέφει δεδομένα εξόδων για τη διαδικασία.
public List<idatasource> Outputs { get; }
Τιμή Ιδιότητας
List<IDataSource>
Μέθοδοι
Προσθέτει νέα δεδομένα στις εισόδους.
public void AddInput(IDataSource dataSource)
Παράμετροι
AddOutput(IDataSource)
Προσθέτει νέα δεδομένα στις εξόδους.
public void AddOutput(IDataSource saveDataSource)
Παράμετροι
Κατηγορία RotateOptions
Info
Αναπαριστά επιλογές περιστροφής για το plugin Documentize.Optimizer.
public sealed class RotateOptions : PluginBaseOptions, IPluginOptions
Κληρονομικότητα
object ←
PluginBaseOptions ←
RotateOptions
Υλοποιήσεις
Κληρονομούμενα Μέλη
- 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()
Κατασκευαστές
RotateOptions()
Αρχικοποιεί μια νέα instance του αντικειμένου Documentize.RotateOptions με προεπιλεγμένες επιλογές.
Ιδιότητες
Rotation
Αποκτά ή ορίζει την περιστροφή νέων σελίδων.
public Rotation Rotation { get; set; }
Τιμή Ιδιοτήτων
Rotation
Κατηγορία StreamDataSource
Info
Αναπαριστά την πηγή δεδομένων ροής για τις λειτουργίες φόρτωσης και αποθήκευσης ενός πρόσθετου.
public sealed class StreamDataSource : IDataSource
Κληρονομικότητα
object ←
StreamDataSource
Υλοποιεί
Κληρονομημένα Μέλη
Κατασκευαστές
StreamDataSource(Stream)
Αρχικοποιεί μια νέα πηγή δεδομένων ροής με το καθορισμένο αντικείμενο ροής.
public StreamDataSource(Stream data)
Παράμετροι
Ιδιότητες
Data
Λαμβάνει το αντικείμενο ροής της τρέχουσας πηγής δεδομένων.
public Stream Data { get; }
Τιμή Ιδιότητας
Stream
DataType
Τύπος πηγής δεδομένων (ροής).
public DataType DataType { get; }
Τιμή Ιδιότητας
DataType
Κατηγορία StringResult
Info
Αναπαριστά το αποτέλεσμα λειτουργίας με τη μορφή συμβολοσειράς.
public sealed class StringResult : IOperationResult
Κληρονομικότητα
object ←
StringResult
Υλοποιεί
Κληρονομούμενα Μέλη
Ιδιότητες
Δεδομένα
Επιστρέφει τα ακατέργαστα δεδομένα.
public object Data { get; }
Τιμή Ιδιότητας
object
IsFile
Δείχνει εάν το αποτέλεσμα είναι μια διαδρομή σε ένα αρχείο εξόδου.
public bool IsFile { get; }
Τιμή Ιδιότητας
bool
IsStream
Δείχνει εάν το αποτέλεσμα είναι μια διαδρομή σε ένα αρχείο εξόδου.
public bool IsStream { get; }
Τιμή Ιδιότητας
bool
IsString
Δείχνει εάν το αποτέλεσμα είναι μια συμβολοσειρά.
public bool IsString { get; }
Τιμή Ιδιότητας
bool
Κείμενο
Επιστρέφει τη συμβολική αναπαράσταση του αποτελέσματος.
public string Text { get; }
Τιμή Ιδιότητας
string
Μέθοδοι
ToFile()
Δοκιμάζει να μετατρέψει το αποτέλεσμα σε αρχείο.
Επιστρέφει
string : Μια συμβολοσειρά που αναπαριστά τη διαδρομή στο αρχείο εξόδου εάν το αποτέλεσμα είναι αρχείο; αλλιώς null
.
ToStream()
Δοκιμάζει να μετατρέψει το αποτέλεσμα σε αντικείμενο ροής.
Επιστρέφει
Stream : Ένα αντικείμενο ροής που αναπαριστά τα δεδομένα εξόδου εάν το αποτέλεσμα είναι ροή; αλλιώς null
.
ToString()
Δοκιμάζει να μετατρέψει το αποτέλεσμα σε συμβολοσειρά.
public override string ToString()
Επιστρέφει
string : Μια συμβολοσειρά που αναπαριστά το περιεχόμενο κειμένου εάν το αποτέλεσμα είναι συμβολοσειρά; αλλιώς επιστρέφει το base.ToString().
Κατηγορία TiffConverter
Info
Αντιπροσωπεύει το plugin Documentize.TiffConverter. Χρησιμοποιείται για τη μετατροπή εγγράφων PDF σε μορφή TIFF.
public sealed class TiffConverter
Κληρονομικότητα
object ←
TiffConverter
Κληρονομούμενα Μέλη
Παραδείγματα
Το παράδειγμα δείχνει πώς να μετατρέψετε ένα έγγραφο PDF σε μορφή TIFF.
// create TiffConverter
var plugin = new TiffConverter();
// create PdfToTiffOptions object to set instructions
var opt = new PdfToTiffOptions();
// add input file path
opt.AddInput(new FileDataSource(inputPath));
// set output file path
opt.AddOutput(new DirectoryDataSource(outputPath));
// perform the process
plugin.Process(opt);
Κατασκευαστές
TiffConverter()
Μέθοδοι
Process(PdfToTiffOptions)
Αρχίζει την επεξεργασία Documentize.TiffConverter με τις καθορισμένες παραμέτρους.
public ResultContainer Process(PdfToTiffOptions options)
Παράμετροι
options
PdfToTiffOptions: Ένα αντικείμενο επιλογών που περιέχει οδηγίες για το Documentize.TiffConverter.
Επιστρέφει
ResultContainer : Ένα αντικείμενο ResultContainer που περιέχει το αποτέλεσμα της λειτουργίας.
Info
Αναπαριστά τις επιλογές εξαγωγής κειμένου για το plugin Documentize.TextExtractor.
public sealed class TextExtractorOptions : PdfExtractorOptions, IPluginOptions
Κληρονομικότητα
object ←
PdfExtractorOptions ←
TextExtractorOptions
Υλοποιεί
Κληρονομούμενα Μέλη
- PdfExtractorOptions.AddInput(IDataSource),
- PdfExtractorOptions.Inputs,
- PdfExtractorOptions.OperationName,
- object.GetType(),
- object.ToString(),
- object.Equals(object?),
- object.Equals(object?, object?),
- object.ReferenceEquals(object?, object?),
- object.GetHashCode()
Παραδείγματα
Το παράδειγμα δείχνει πώς να εξαγάγετε το κείμενο από ένα έγγραφο PDF.
// δημιουργία αντικειμένου TextExtractor για την εξαγωγή περιεχομένων PDF
using (TextExtractor extractor = new TextExtractor())
{
// δημιουργία αντικειμένου TextExtractorOptions για την ορισμός του TextFormattingMode (Καθαρό ή Ακατέργαστο - προεπιλογή)
extractorOptions = new TextExtractorOptions(TextExtractorOptions.TextFormattingMode.Pure);
// προσθήκη διαδρομής αρχείου εισόδου στις πηγές δεδομένων
extractorOptions.AddInput(new FileDataSource(inputPath));
// εκτέλεση διαδικασίας εξαγωγής
ResultContainer resultContainer = extractor.Process(extractorOptions);
// λήψη του εξαγόμενου κειμένου από το αντικείμενο ResultContainer
string textExtracted = resultContainer.ResultCollection[0].ToString();
}
Παρατηρήσεις
Το αντικείμενο Documentize.TextExtractorOptions χρησιμοποιείται για να καθορίσει το Documentize.TextExtractorOptions.TextFormattingMode και άλλες επιλογές για τη διαδικασία εξαγωγής κειμένου.
Επίσης, κληρονομεί συναρτήσεις για την προσθήκη δεδομένων (αρχείων, ροών) που αναπαριστούν τα έγγραφα εισόδου PDF.
Κατασκευαστές
Αρχικοποιεί μια νέα παρουσία του αντικειμένου Documentize.TextExtractorOptions για την καθορισμένη λειτουργία μορφοποίησης κειμένου.
public TextExtractorOptions(TextExtractorOptions.TextFormattingMode formattingMode)
Παράμετροι
Αρχικοποιεί μια νέα παρουσία του αντικειμένου Documentize.TextExtractorOptions με ακατέργαστη (προεπιλογή) λειτουργία μορφοποίησης κειμένου.
public TextExtractorOptions()
Ιδιότητες
Επιστρέφει τη λειτουργία μορφοποίησης.
public TextExtractorOptions.TextFormattingMode FormattingMode { get; }
Τιμή Ιδιότητας
TextExtractorOptions.TextFormattingMode
Επιστρέφει το όνομα της λειτουργίας.
public override string OperationName { get; }
Τιμή Ιδιότητας
string
Κλάση DocConverter
Info
Αναπαριστά το πρόσθετο Documentize.DocConverter. Χρησιμοποιείται για να μετατρέπει έγγραφα PDF σε μορφή DOC/DOCX.
public sealed class DocConverter
Κληρονομικότητα
object ←
DocConverter
Κληρονομούμενα Μέλη
Παραδείγματα
Το παρακάτω παράδειγμα δείχνει πώς να μετατρέψετε ένα έγγραφο PDF σε μορφή Doc.
// δημιουργία DocConverter
var plugin = new DocConverter();
// δημιουργία αντικειμένου PdfToDocOptions για να ορίσετε οδηγίες
var opt = new PdfToDocOptions();
// προσθήκη διαδρομής εισερχόμενου αρχείου
opt.AddInput(new FileDataSource(inputPath));
// ορισμός διαδρομής εξόδου
opt.AddOutput(new FileDataSource(outputPath));
// εκτέλεση της διαδικασίας
plugin.Process(opt);
Κατασκευαστές
DocConverter()
Μέθοδοι
Dispose()
Υλοποίηση του IDisposable.
Process(PdfToDocOptions)
Ξεκινά τη διαδικασία Documentize.DocConverter με τις καθορισμένες παραμέτρους.
public ResultContainer Process(PdfToDocOptions options)
Παράμετροι
options
PdfToDocOptions: Ένα αντικείμενο επιλογών που περιέχει οδηγίες για το Documentize.DocConverter.
Επιστρέφει
ResultContainer : Ένα αντικείμενο Documentize.ResultContainer που περιέχει το αποτέλεσμα της λειτουργίας.
Κλάση EncryptionOptions
Info
Αναπαριστά τις Επιλογές Κρυπτογράφησης για το plugin Documentize.Security.
public class EncryptionOptions : PluginBaseOptions, IPluginOptions
Κληρονομικότητα
object ←
PluginBaseOptions ←
EncryptionOptions
Υλοποιεί
Κληρονομούμενα Μέλη
- 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()
Κατασκευαστές
EncryptionOptions(string, string)
Αρχικοποιεί νέα παρουσία του αντικειμένου Documentize.EncryptionOptions με προεπιλεγμένες επιλογές.
public EncryptionOptions(string ownerPassword, string userPassword)
Παράμετροι
ownerPassword
string: Κωδικός πρόσβασης ιδιοκτήτη.userPassword
string: Κωδικός πρόσβασης χρήστη.
Ιδιότητες
OwnerPassword
Κωδικός πρόσβασης ιδιοκτήτη.
public string OwnerPassword { get; set; }
Τιμή Ιδιότητας
string
UserPassword
Κωδικός πρόσβασης χρήστη.
public string UserPassword { get; set; }
Τιμή Ιδιότητας
string
Κλάση PdfAValidateOptions
Info
Αναπαριστά επιλογές για την επικύρωση της συμμόρφωσης PDF/A εγγράφων PDF με το πρόσθετο Documentize.PdfAConverter.
public sealed class PdfAValidateOptions : PdfAOptionsBase, IPluginOptions
Κληρονομικότητα
object ←
PdfAOptionsBase ←
PdfAValidateOptions
Υλοποιεί
Κληρονομούμενα Μέλη
- 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()
Κατασκευαστές
PdfAValidateOptions()
public PdfAValidateOptions()
Info
Αντιπροσωπεύει τη βασική λειτουργικότητα για την εξαγωγή κειμένου, εικόνων και άλλων τύπων περιεχομένου που μπορεί να εμφανίζονται στις σελίδες εγγράφων PDF.
public abstract class PdfExtractor : IDisposable
Κληρονομιά
object ←
PdfExtractor
Παράγωγες
Υλοποιεί
Κληρονομούμενα Μέλη
Παραδείγματα
Το παράδειγμα δείχνει πώς να εξάγετε το κειμενικό περιεχόμενο ενός εγγράφου PDF.
// δημιουργία αντικειμένου TextExtractor για την εξαγωγή περιεχομένου PDF
using (TextExtractor extractor = new TextExtractor())
{
// δημιουργία αντικειμένου TextExtractorOptions για ρύθμιση οδηγιών
textExtractorOptions = new TextExtractorOptions();
// προσθήκη διαδρομής εισόδου
textExtractorOptions.AddInput(new FileDataSource(inputPath));
// εκτέλεση διαδικασίας εξαγωγής
ResultContainer resultContainer = extractor.Process(textExtractorOptions);
// λήψη του εξαγόμενου κειμένου από το αντικείμενο ResultContainer
string textExtracted = resultContainer.ResultCollection[0].ToString();
}
Παρατηρήσεις
Το αντικείμενο Documentize.TextExtractor χρησιμοποιείται για την εξαγωγή κειμένου, ή το Documentize.ImageExtractor για την εξαγωγή εικόνων.
Κατασκευαστές
Μέθοδοι
Υλοποίηση του IDisposable. Στην πραγματικότητα, δεν είναι απαραίτητο για το PdfExtractor.
Αρχίζει τη διαδικασία PdfExtractor με τις καθορισμένες παραμέτρους.
public ResultContainer Process(IPluginOptions pdfExtractorOptions)
Παράμετροι
pdfExtractorOptions
IPluginOptions: Ένα αντικείμενο επιλογών που περιέχει οδηγίες για το PdfExtractor.
Επιστρέφει
ResultContainer : Ένα αντικείμενο ResultContainer που περιέχει το αποτέλεσμα της εξαγωγής.
Info
Αναπαριστά επιλογές για τα πρόσθετα TextExtractor και ImageExtractor.
public abstract class PdfExtractorOptions : IPluginOptions
Κληρονομικότητα
object ←
PdfExtractorOptions
Παράγωγα
Υλοποιεί
Κληρονομούμενα Μέλη
Παρατηρήσεις
Το Documentize.PdfExtractorOptions περιέχει βασικές συναρτήσεις για την προσθήκη δεδομένων (αρχεία, ρεύματα) που αναπαριστούν έγγραφα PDF εισόδου.
Παρακαλώ δημιουργήστε τα Documentize.TextExtractorOptions ή ImageExtractorOptions αντί αυτού.
Ιδιότητες
Επιστρέφει τη συλλογή δεδομένων του πρόσθετου PdfExtractor.
public List<idatasource> Inputs { get; }
Τιμή Ιδιότητας
List<IDataSource>
Επιστρέφει το όνομα της λειτουργίας
public virtual string OperationName { get; }
Τιμή Ιδιότητας
string
Μέθοδοι
Προσθέτει νέα πηγή δεδομένων στη συλλογή δεδομένων του πρόσθετου PdfExtractor.
public void AddInput(IDataSource dataSource)
Παράμετροι
dataSource
IDataSource: Πηγή δεδομένων προς προσθήκη. :
Κλάση PdfToDocOptions
Info
Αναπαριστά τις επιλογές μετατροπής PDF σε DOC για το plugin Documentize.DocConverter.
public sealed class PdfToDocOptions : PdfConverterOptions, IPluginOptions
Κληρονομικότητα
object ←
PdfConverterOptions ←
PdfToDocOptions
Υλοποιεί
Κληρονομούμενα Μέλη
- 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()
Κατασκευαστές
PdfToDocOptions()
Εκκινεί μια νέα παρουσία του αντικειμένου Documentize.PdfToDocOptions με προεπιλεγμένες επιλογές.
Κλάση ResultContainer
Info
Αναπαριστά ένα δοχείο που περιέχει τη συλλογή αποτελεσμάτων της επεξεργασίας του πρόσθετου.
public class ResultContainer
Κληρονομικότητα
object ←
ResultContainer
Κληρονομούμενα Μέλη
Ιδιότητες
ResultCollection
Λαμβάνει τη συλλογή των αποτελεσμάτων των λειτουργιών
public List<ioperationresult> ResultCollection { get; }
Αξία Ιδιότητας
List<IOperationResult>
Κλάση TableBuilder
Info
Η κλάση αναπαριστά έναν κατασκευαστή για πίνακα σε σελίδα pdf.
public class TableBuilder
Κληρονομικότητα
object ←
TableBuilder
Παράγωγα
Κληρονόμημένα Μέλη
Μέθοδοι
AddRow()
Προσθέστε νέα γραμμή στον πίνακα.
public virtual TableRowBuilder AddRow()
Επιστροφές
TableRowBuilder : Παράδειγμα της τρέχουσας Documentize.TableRowBuilder.
AddTable()
Προσθέστε νέο πίνακα στο έγγραφο.
public TableBuilder AddTable()
Επιστροφές
TableBuilder : Παράδειγμα της τρέχουσας Documentize.TableBuilder.
InsertPageAfter(int)
Εισαγάγετε σελίδα μετά από τη συγκεκριμένη σελίδα.
public TableOptions InsertPageAfter(int page)
Παράμετροι
page
int: Αριθμός σελίδας για την οποία θα εισαχθεί ο πίνακας.
Επιστροφές
TableOptions : Παράδειγμα της τρέχουσας Documentize.TableOptions.
InsertPageBefore(int)
Εισαγάγετε σελίδα πριν από τη συγκεκριμένη σελίδα.
public TableOptions InsertPageBefore(int page)
Παράμετροι
page
int: Αριθμός σελίδας για την οποία θα εισαχθεί ο πίνακας.
Επιστροφές
TableOptions : Παράδειγμα της τρέχουσας Documentize.TableOptions.
Τελεστές
implicit operator TableOptions(TableBuilder)
Μετατρέπει τον κατασκευαστή Documentize.TableBuilder σε επιλογές Documentize.TableOptions
public static implicit operator TableOptions(TableBuilder builder)
Παράμετροι
builder
TableBuilder: Παράδειγμα της τρέχουσας Documentize.TableBuilder.
Επιστροφές
TableOptions : Αποτέλεσμα της μετατροπής σε PdfGeneratorTableOptions.
Κλάση TableCellBuilder
Info
Η κλάση αντιπροσωπεύει χειριστή για το κελί πίνακα.
public class TableCellBuilder : TableRowBuilder
Κληρονομιά
object ←
TableBuilder ←
TableRowBuilder ←
TableCellBuilder
Κληρονομημένα Μέλη
- TableRowBuilder.AddCell(),
- TableRowBuilder.AddRow(),
- TableBuilder.AddRow(),
- TableBuilder.AddTable(),
- TableBuilder.InsertPageAfter(int),
- TableBuilder.InsertPageBefore(int),
- object.GetType(),
- object.MemberwiseClone(),
- object.ToString(),
- object.Equals(object?),
- object.Equals(object?, object?),
- object.ReferenceEquals(object?, object?),
- object.GetHashCode()
Μέθοδοι
AddCell()
Προσθέστε κελί στον πίνακα.
public override TableCellBuilder AddCell()
Επιστροφές
TableCellBuilder : Το στιγμιότυπο της τρέχουσας Documentize.TableCellBuilder.
AddParagraph(params string[])
Προσθέστε παραγράφους στο κελί πίνακα.
public TableCellBuilder AddParagraph(params string[] paragraphs)
Παράμετροι
paragraphs
string[]: Κείμενο για τις παραγράφους.
Επιστροφές
TableCellBuilder : Το στιγμιότυπο της τρέχουσας Documentize.TableCellBuilder.
Info
Αναπαριστά το plugin Documentize.TextExtractor. Χρησιμοποιείται για την εξαγωγή κειμένου από έγγραφα PDF.
public class TextExtractor : PdfExtractor, IDisposable
Κληρονομικότητα
object ←
PdfExtractor ←
TextExtractor
Υλοποιεί
Κληρονομούμενα Μέλη
- PdfExtractor.Process(IPluginOptions),
- PdfExtractor.Dispose(),
- object.GetType(),
- object.MemberwiseClone(),
- object.ToString(),
- object.Equals(object?),
- object.Equals(object?, object?),
- object.ReferenceEquals(object?, object?),
- object.GetHashCode()
Παραδείγματα
Το παράδειγμα δείχνει πώς να εξάγετε περιεχόμενο κειμένου ενός εγγράφου PDF.
// create TextExtractor object to extract text in PDF contents
using (var plugin = new TextExtractor())
{
// create TextExtractorOptions
var opt = new TextExtractorOptions();
// add input file path
opt.AddInput(new FileDataSource(inputPath));
// perform extraction process
var resultContainer = plugin.Process(opt);
// get the extracted text from the ResultContainer object
var textExtracted = resultContainer.ResultCollection[0].ToString();
}
Κατασκευαστές
Κλάση Ορθογώνιο
Info
Κλάση που αντιπροσωπεύει ορθογώνιο.
Κληρονομικότητα
object ←
Rectangle
Κληρονομούμενα Μέλη
Κατασκευαστές
Rectangle(double, double, double, double)
Κατασκευαστής του Ορθογωνίου.
public Rectangle(double llx, double lly, double urx, double ury)
Παράμετροι
llx
double: X της κάτω αριστερής γωνίας.lly
double: Y της κάτω αριστερής γωνίας.urx
double: X της άνω δεξιάς γωνίας.ury
double: Y της άνω δεξιάς γωνίας.
Μέγεθος Σελίδας Κατηγορίας
Info
Κατηγορία που αναπαριστά το μέγεθος της σελίδας σε έγγραφο PDF.
Κληρονομικότητα
object ←
PageSize
Παράγωγο
Κληρονομημένα Μέλη
Κατασκευαστές
PageSize()
Κατασκευαστής του Documentize.PageSize. Α4 μεγέθη από προεπιλογή.
PageSize(double, double)
Κατασκευαστής του Documentize.PageSize.
public PageSize(double width, double height)
Παράμετροι
width
double: Πλάτος της σελίδας.height
double: Ύψος της σελίδας.
Ιδιότητες
A0
Μέγεθος A0 (1189x840 mm).
public static PageSize A0 { get; }
Τιμή Ιδιότητας
PageSize
A1
Μέγεθος A1 (840x594 mm).
public static PageSize A1 { get; }
Τιμή Ιδιότητας
PageSize
A2
Μέγεθος A2 (594x420 mm).
public static PageSize A2 { get; }
Τιμή Ιδιότητας
PageSize
A3
Μέγεθος A3 (420x297 mm).
public static PageSize A3 { get; }
Τιμή Ιδιότητας
PageSize
A4
Μέγεθος A4 (297x210 mm).
public static PageSize A4 { get; }
Τιμή Ιδιότητας
PageSize
A5
Μέγεθος A5 (210x148 mm).
public static PageSize A5 { get; }
Τιμή Ιδιότητας
PageSize
A6
Μέγεθος A6 (148x105 mm).
public static PageSize A6 { get; }
Τιμή Ιδιότητας
PageSize
B5
Μέγεθος B5 (250x176 mm).
public static PageSize B5 { get; }
Τιμή Ιδιότητας
PageSize
Ύψος
Λαμβάνει ή ορίζει το ύψος της σελίδας.
public double Height { get; set; }
Τιμή Ιδιότητας
double
IsLandscape
Λαμβάνει τον προσανατολισμό της σελίδας. Επιστρέφει αληθές αν αυτός είναι οριζόντιος προσανατολισμός και ψευδές αν είναι κατακόρυφος.
public bool IsLandscape { get; }
Τιμή Ιδιότητας
bool
P11x17
Μέγεθος 11x17 ίντσες.
public static PageSize P11x17 { get; }
Τιμή Ιδιότητας
PageSize
PageLedger
Μέγεθος Ledger (432x279 mm).
public static PageSize PageLedger { get; }
Τιμή Ιδιότητας
PageSize
PageLegal
Μέγεθος Legal (356x216 mm).
public static PageSize PageLegal { get; }
Τιμή Ιδιότητας
PageSize
PageLetter
Μέγεθος Letter (279x216 mm).
public static PageSize PageLetter { get; }
Τιμή Ιδιότητας
PageSize
Πλάτος
Λαμβάνει ή ορίζει το πλάτος της σελίδας.
public double Width { get; set; }
Τιμή Ιδιότητας
double
Μετατροπέας Png
Info
Αναπαριστά το plugin Documentize.PngConverter. Χρησιμοποιείται για να μετατρέπει έγγραφα PDF σε μορφή PNG.
public sealed class PngConverter
Κληρονομικότητα
object ←
PngConverter
Κληρονομούμενα Μέλη
Παραδείγματα
Το παράδειγμα δείχνει πώς να μετατρέψετε ένα έγγραφο PDF σε μορφή PNG.
// create PngConverter
var plugin = new PngConverter();
// create PdfToPngOptions object to set instructions
var opt = new PdfToPngOptions();
// add input file path
opt.AddInput(new FileDataSource(inputPath));
// set output file path
opt.AddOutput(new DirectoryDataSource(outputPath));
// perform the process
plugin.Process(opt);
Δομές
PngConverter()
Μέθοδοι
Process(PdfToPngOptions)
Αρχίζει τη διαδικασία Documentize.PngConverter με τις καθορισμένες παραμέτρους.
public ResultContainer Process(PdfToPngOptions options)
Παράμετροι
options
PdfToPngOptions: Ένα αντικείμενο επιλογών που περιέχει οδηγίες για το Documentize.PngConverter.
Επιστρέφει
ResultContainer : Ένα αντικείμενο ResultContainer που περιέχει το αποτέλεσμα της λειτουργίας.
Μήνυμα Τάξης
Info
Ένα μήνυμα ολοκλήρωσης συνομιλίας που δημιουργήθηκε από το μοντέλο.
Κληρονομικότητα
object ←
Message
Κληρονομούμενα Μέλη
Κατασκευαστές
Message()
Ιδιότητες
Περιεχόμενο
Τα περιεχόμενα του μηνύματος.
[JsonProperty("content")]
public string Content { get; set; }
Τιμή Ιδιότητας
string
Ρόλος
Ορίζει ή αποκτά τον ρόλο του συγγραφέα αυτού του μηνύματος.
[JsonProperty("role")]
[JsonConverter(typeof(StringEnumConverter), new object[] { true })]
public Role Role { get; set; }
Τιμή Ιδιότητας
Role
Πληροφορίες Κατηγορίας
Info
Η κατηγορία παρέχει πληροφορίες σχετικά με την τρέχουσα κατασκευή προϊόντος.
Κληρονομία
object ←
Info
Κληρονομούμενα Μέλη
Πεδία
AssemblyVersion Έκδοση Assembly.
Τιμή Πεδίου
string
Προϊόν
Όνομα προϊόντος.
public const string Product = "Documentize"
Τιμή Πεδίου
string
Προσθήκη Επιλογών Χρονοσήμανσης
Info
Αναπαριστά τις επιλογές προσθήκης χρονοσήμανσης για το πρόσθετο Documentize.Timestamp.
public class AddTimestampOptions : PluginBaseOptions, IPluginOptions
Κληρονομία
object ←
PluginBaseOptions ←
AddTimestampOptions
Υλοποιεί
Κληρονομούμενα Μέλη
- 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()
Κατασκευαστές
AddTimestampOptions(Stream, string, string, string)
Αρχικοποιεί μια νέα αναπαράσταση του αντικειμένου Documentize.AddTimestampOptions με προεπιλεγμένες επιλογές.
public AddTimestampOptions(Stream pfx, string password, string serverUrl, string serverBasicAuthCredentials = "")
Παράμετροι
pfx
Stream: Η διαδρομή προς το αρχείο pfx.password
string: Ο κωδικός πρόσβασης για το αρχείο pfx.serverUrl
string: Η διεύθυνση URL του διακομιστή χρονοσήμανσης.serverBasicAuthCredentials
string: Τα διαπιστευτήρια βασικής ταυτοποίησης, το όνομα χρήστη και ο κωδικός πρόσβασης συνδυάζονται σε μια συμβολοσειρά “όνομα_χρήστη:κωδικός_πρόσβασης”. (Προαιρετικό).
AddTimestampOptions(string, string, string, string)
Αρχικοποιεί μια νέα αναπαράσταση του αντικειμένου Documentize.AddTimestampOptions με προεπιλεγμένες επιλογές.
public AddTimestampOptions(string pfx, string password, string serverUrl, string serverBasicAuthCredentials = "")
Παράμετροι
pfx
string: Η διαδρομή προς το αρχείο pfx.password
string: Ο κωδικός πρόσβασης για το αρχείο pfx.serverUrl
string: Η διεύθυνση URL του διακομιστή χρονοσήμανσης.serverBasicAuthCredentials
string: Τα διαπιστευτήρια βασικής ταυτοποίησης, το όνομα χρήστη και ο κωδικός πρόσβασης συνδυάζονται σε μια συμβολοσειρά “όνομα_χρήστη:κωδικός_πρόσβασης”. (Προαιρετικό).
Ροή Αποτελέσματος Τάξης
Info
Αντιπροσωπεύει το αποτέλεσμα λειτουργίας με τη μορφή Ροής.
public sealed class StreamResult : IOperationResult
Κληρονομικότητα
object ←
StreamResult
Υλοποιεί
Κληρονομούμενα Μέλη
Ιδιότητες
Δεδομένα
Αποκτά ακατέργαστα δεδομένα.
public object Data { get; }
Τιμή Ιδιότητας
object
IsFile
Δείχνει αν το αποτέλεσμα είναι μια διαδρομή σε ένα αρχείο εξόδου.
public bool IsFile { get; }
Τιμή Ιδιότητας
bool
IsStream
Δείχνει αν το αποτέλεσμα είναι μια διαδρομή σε ένα αρχείο εξόδου.
public bool IsStream { get; }
Τιμή Ιδιότητας
bool
IsString
Δείχνει αν το αποτέλεσμα είναι μια συμβολοσειρά.
public bool IsString { get; }
Τιμή Ιδιότητας
bool
Μέθοδοι
ToFile()
Δοκιμάζει να μετατρέψει το αποτέλεσμα σε αρχείο.
Επιστρέφει
string : Μια συμβολοσειρά που αντιπροσωπεύει τη διαδρομή στο αρχείο εξόδου αν το αποτέλεσμα είναι αρχείο; αλλιώς null
.
ToStream()
Δοκιμάζει να μετατρέψει το αποτέλεσμα σε αντικείμενο ροής.
Επιστρέφει
Stream : Ένα αντικείμενο ροής που αντιπροσωπεύει τα δεδομένα εξόδου αν το αποτέλεσμα είναι ροή; αλλιώς null
.
Σελίδα Πληροφοριών
Info
Αναπαριστά τις πληροφορίες της σελίδας.
public class PageInfo : PageSize
Κληρονομικότητα
object ←
PageSize ←
PageInfo
Κληρονομούμενα Μέλη
- 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()
Κατασκευαστές
PageInfo()
Κατασκευαστής της Documentize.PageInfo.
PageInfo(double, double)
Κατασκευαστής της Documentize.PageInfo.
public PageInfo(double width, double height)
Παράμετροι
Ιδιότητες
MarginBottom
Αποκτά ή ορίζει μια τιμή που υποδεικνύει το κάτω περιθώριο.
public double MarginBottom { get; set; }
Τιμή Ιδιοτήτων
double
MarginLeft
Αποκτά ή ορίζει μια τιμή που υποδεικνύει το αριστερό περιθώριο.
public double MarginLeft { get; set; }
Τιμή Ιδιοτήτων
double
MarginRight
Αποκτά ή ορίζει μια τιμή που υποδεικνύει το δεξί περιθώριο.
public double MarginRight { get; set; }
Τιμή Ιδιοτήτων
double
MarginTop
Αποκτά ή ορίζει μια τιμή που υποδεικνύει το επάνω περιθώριο.
public double MarginTop { get; set; }
Τιμή Ιδιοτήτων
double
Συγχώνευση Κλάσης
Info
Αναπαριστά το plugin Documentize.Merger. Χρησιμοποιείται για να συγχωνεύσει πολλαπλά έγγραφα PDF σε ένα μόνο PDF.
public sealed class Merger
Κληρονομιά
object ←
Merger
Κληρονομημένα Μέλη
Παραδείγματα
Το παράδειγμα δείχνει πώς να συγχωνεύσετε δύο έγγραφα PDF.
// δημιουργία Merger
var plugin = new Merger();
// δημιουργία αντικειμένου MergeOptions για ρύθμιση οδηγιών
var opt = new MergeOptions();
// προσθήκη διαδρομών εισόδου αρχείων
opt.AddInput(new FileDataSource(inputPath1));
opt.AddInput(new FileDataSource(inputPath2));
// καθορισμός διαδρομής εξόδου αρχείου
opt.AddOutput(new FileDataSource(outputPath));
// εκτέλεση της διαδικασίας
plugin.Process(opt);
Κατασκευαστές
Merger()
Μέθοδοι
Process(MergeOptions)
Αρχίζει τη διαδικασία Documentize.Merger με τις καθορισμένες παραμέτρους.
public ResultContainer Process(MergeOptions options)
Παράμετροι
options
MergeOptions: Ένα αντικείμενο επιλογών που περιέχει οδηγίες για τη λειτουργία.
Επιστρέφει
ResultContainer : Ένα αντικείμενο Documentize.ResultContainer που περιέχει το αποτέλεσμα της λειτουργίας.
Τάξη HtmlConverter
Info
Αναπαριστά το plugin Documentize.HtmlConverter. Χρησιμοποιείται για τη μετατροπή εγγράφων PDF σε μορφή HTML και εγγράφων HTML σε μορφή PDF.
public sealed class HtmlConverter : IDisposable
Κληρονομικότητα
object ←
HtmlConverter
Υλοποιεί
Κληρονομημένα Μέλη
Παραδείγματα
Το παράδειγμα δείχνει πώς να μετατρέψετε PDF σε έγγραφο HTML.
// δημιουργία HtmlConverter
var plugin = new HtmlConverter();
// δημιουργία αντικειμένου PdfToHtmlOptions για ορισμό του τύπου δεδομένων εξόδου ως αρχείο με ενσωματωμένους πόρους
var opt = new PdfToHtmlOptions(PdfToHtmlOptions.SaveDataType.FileWithEmbeddedResources);
// προσθήκη διαδρομής εισόδου
opt.AddInput(new FileDataSource(inputPath));
// ορισμός διαδρομής εξόδου
opt.AddOutput(new FileDataSource(outputPath));
plugin.Process(opt);
Το παράδειγμα δείχνει πώς να μετατρέψετε HTML σε έγγραφο PDF.
// δημιουργία HtmlConverter
var plugin = new HtmlConverter();
// δημιουργία HtmlToPdfOptions
var opt = new HtmlToPdfOptions();
// προσθήκη διαδρομής εισόδου
opt.AddInput(new FileDataSource(inputPath));
// ορισμός διαδρομής εξόδου
opt.AddOutput(new FileDataSource(outputPath));
plugin.Process(opt);
Κατασκευαστές
HtmlConverter()
Μέθοδοι
Dispose()
Υλοποίηση του IDisposable.
Process(IPluginOptions)
Ξεκινά τη διαδικασία Documentize.HtmlConverter με τις καθορισμένες παραμέτρους.
public ResultContainer Process(IPluginOptions options)
Παράμετροι
options
IPluginOptions: Ένα αντικείμενο επιλογών που περιέχει οδηγίες για το Documentize.HtmlConverter.
Επιστρέφει
ResultContainer : Ένα αντικείμενο Documentize.ResultContainer που περιέχει το αποτέλεσμα της λειτουργίας.
Τάξη JpegConverter
Info
Αντιπροσωπεύει το plugin Documentize.JpegConverter. Χρησιμοποιείται για τη μετατροπή εγγράφων PDF σε μορφή JPEG.
public sealed class JpegConverter
Κληρονομικότητα
object ←
JpegConverter
Κληρονομούμενα Μέλη
Παραδείγματα
Το παράδειγμα δείχνει πώς να μετατρέψετε έγγραφο PDF σε μορφή JPEG.
// create JpegConverter
var plugin = new JpegConverter();
// create PdfToJpegOptions object to set instructions
var opt = new PdfToJpegOptions();
// add input file path
opt.AddInput(new FileDataSource(inputPath));
// set output file path
opt.AddOutput(new DirectoryDataSource(outputPath));
// perform the process
plugin.Process(opt);
Κατασκευαστές
JpegConverter()
Μέθοδοι
Process(PdfToJpegOptions)
Ξεκινά τη διαδικασία Documentize.JpegConverter με τις καθορισμένες παραμέτρους.
public ResultContainer Process(PdfToJpegOptions options)
Παράμετροι
options
PdfToJpegOptions: Ένα αντικείμενο επιλογών που περιέχει οδηγίες για το Documentize.JpegConverter.
Επιστρέφει
ResultContainer: Ένα αντικείμενο ResultContainer που περιέχει το αποτέλεσμα της λειτουργίας.
Τάξη PdfAConverter
Info
Αντιπροσωπεύει ένα plugin για τη διαχείριση της μετατροπής εγγράφων PDF σε μορφή PDF/A και για την επικύρωση της συμμόρφωσης PDF/A.
public sealed class PdfAConverter
Κληρονομικότητα
object ←
PdfAConverter
Κληρονομημένα Μέλη
Παραδείγματα
Το παράδειγμα δείχνει πώς να επικυρώσετε τη συμμόρφωση του εγγράφου PDF στη μορφή PDF/A (PDF/A-1a στην περίπτωση αυτή):
// Δημιουργία της κλάσης επιλογών για τη ρύθμιση της διαδικασίας επικύρωσης
var options = new PdfAValidateOptions
{
PdfAVersion = PdfAStandardVersion.PDF_A_1A
};
// Προσθήκη ενός ή περισσότερων αρχείων προς επικύρωση
options.AddInput(new FileDataSource("path_to_your_first_pdf_file.pdf")); // αντικαταστήστε με την πραγματική διαδρομή του αρχείου σας
options.AddInput(new FileDataSource("path_to_your_second_pdf_file.pdf"));
// προσθέστε περισσότερα αρχεία αν χρειαστεί
// Δημιουργία της παρουσίας του plugin
var plugin = new PdfAConverter();
// Εκτέλεση της επικύρωσης και λήψη αποτελεσμάτων
var resultContainer = plugin.Process(options);
// Ελέγξτε την ιδιότητα resultContainer.ResultCollection για τα αποτελέσματα επικύρωσης για κάθε αρχείο:
for (var i = 0; i < resultContainer.ResultCollection.Count; i++)
{
var result = resultContainer.ResultCollection[i];
var validationResult = (PdfAValidationResult) result.Data;
var isValid = validationResult.IsValid; // Αποτέλεσμα επικύρωσης για το i-ο έγγραφο
}
Το παράδειγμα δείχνει πώς να μετατρέψετε το έγγραφο PDF σε μορφή PDF/A (PDF/A-3b στην περίπτωση αυτή):
// Δημιουργία της κλάσης επιλογών για τη ρύθμιση της διαδικασίας μετατροπής
var options = new PdfAConvertOptions
{
PdfAVersion = PdfAStandardVersion.PDF_A_3B
};
// Προσθήκη του αρχείου πηγής
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf")); // αντικαταστήστε με την πραγματική διαδρομή του αρχείου σας
// Προσθήκη της διαδρομής για την αποθήκευση του μετατραπέντος αρχείου
options.AddOutput(new FileDataSource("path_to_the_converted_file.pdf"));
// Δημιουργία της παρουσίας του plugin
var plugin = new PdfAConverter();
// Εκτέλεση της μετατροπής
plugin.Process(options);
Κατασκευαστές
PdfAConverter()
Μέθοδοι
Process(IPluginOptions)
Αρχίζει μια διαδικασία μετατροπής ή επικύρωσης PDF/A με τις δεδομένες επιλογές.
public ResultContainer Process(IPluginOptions options)
Παράμετροι
options
IPluginOptions: Ένα αντικείμενο επιλογών που περιέχει οδηγίες για το plugin. Πρέπει να είναι ένα στιγμιότυπο της κλάσης Documentize.PdfAConvertOptions ή της κλάσης Documentize.PdfAValidateOptions.
Επιστρέφει
ResultContainer : Ένα αντικείμενο Documentize.ResultContainer που περιέχει το αποτέλεσμα της επεξεργασίας.
Τάξη PdfToPngOptions
Info
Αναπαριστά τις επιλογές μετατροπής PDF σε PNG για το plugin Documentize.PngConverter.
public sealed class PdfToPngOptions : PluginBaseOptions, IPluginOptions
Κληρονομικότητα
object ←
PluginBaseOptions ←
PdfToPngOptions
Υλοποιεί
Κληρονομούμενα Μέλη
- 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()
Κατασκευαστές
PdfToPngOptions()
Αρχικοποιεί μια νέα έκδοση του αντικειμένου Documentize.PdfToPngOptions.
Ιδιότητες
OutputResolution
Λαμβάνει ή ορίζει την τιμή ανάλυσης των παραγόμενων εικόνων.
public int OutputResolution { get; set; }
Τιμή Ιδιότητας
int
PageList
Λαμβάνει ή ορίζει μια λίστα σελίδων για τη διαδικασία.
public List<int> PageList { get; set; }
Τιμή Ιδιότητας
List<int>
Υπογραφή Κατηγορίας
Info
Αντιπροσωπεύει το plugin Documentize.Signature.
public sealed class Signature
Κληρονομικότητα
object ←
Signature
Κληρονομούμενα Μέλη
Παραδείγματα
Το παράδειγμα δείχνει πώς να υπογράψετε έγγραφο PDF.
// create Signature
var plugin = new Signature();
// create SignOptions object to set instructions
var opt = new SignOptions(inputPfx, inputPfxPassword);
// add input file path
opt.AddInput(new FileDataSource(inputPath));
// set output file path
opt.AddOutput(new FileDataSource(outputPath));
// perform the process
plugin.Process(opt);
Κατασκευαστές
Signature()
Μέθοδοι
Process(IPluginOptions)
Αρχίζει την επεξεργασία του Documentize.Signature με τις καθορισμένες παραμέτρους.
public ResultContainer Process(IPluginOptions options)
Παράμετροι
options
IPluginOptions: Ένα αντικείμενο επιλογών που περιέχει οδηγίες για το Documentize.Signature.
Επιστρέφει
ResultContainer : Ένα αντικείμενο ResultContainer που περιέχει το αποτέλεσμα της λειτουργίας.
Εξαιρέσεις
InvalidOperationException
Χρονοσφραγίδα Κατηγορίας
Info
Αναπαριστά τον plugin Documentize.Timestamp.
``csharp
public class Timestamp
#### Κληρονομικότητα
[object](https://learn.microsoft.com/dotnet/api/system.object) ←
[Timestamp](Documentize.Timestamp.md)
#### Κληρονομούμενα Μέλη
- [object.GetType\(\)](https://learn.microsoft.com/dotnet/api/system.object.gettype),
- [object.MemberwiseClone\(\)](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone),
- [object.ToString\(\)](https://learn.microsoft.com/dotnet/api/system.object.tostring),
- [object.Equals\(object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\)),
- [object.Equals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\-system\-object\)),
- [object.ReferenceEquals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
- [object.GetHashCode\(\)](https://learn.microsoft.com/dotnet/api/system.object.gethashcode)
## Παραδείγματα
Το παράδειγμα δείχνει πώς να προσθέσετε Χρονοσφραγίδα σε έγγραφο.
```cs
// δημιουργία Χρονοσφραγίδας
var plugin = new Timestamp();
// δημιουργία αντικειμένου AddTimestampOptions για να ορίσετε οδηγίες
var opt = new AddTimestampOptions("path_to_pfx", "password_for_pfx", "timestamp_server_url");
// προσθήκη διαδρομής εισόδου
opt.AddInput(new FileDataSource("path_to_pdf"));
// ορισμός διαδρομής εξόδου
opt.AddOutput(new FileDataSource("path_to_result_pdf"));
// εκτέλεση της διαδικασίας
plugin.Process(opt);
Κατασκευαστές
Timestamp()
Μέθοδοι
Process(AddTimestampOptions)
Ξεκινά την επεξεργασία της Documentize.Timestamp με τις καθορισμένες παραμέτρους.
public ResultContainer Process(AddTimestampOptions options)
Παράμετροι
options
AddTimestampOptions: Ένα αντικείμενο επιλογών που περιέχει οδηγίες για τη Documentize.AddTimestampOptions.
Επιστρέφει
ResultContainer : Ένα αντικείμενο ResultContainer που περιέχει το αποτέλεσμα της λειτουργίας.