GetDocumentInfo
Editor.GetDocumentInfo method
Restituisce i metadati relativi al documento, che è stato caricato in questa istanza “Editor”
public IDocumentInfo GetDocumentInfo(string password)
Parametro | Tipo | Descrizione |
---|---|---|
password | String | L’utente può specificare una password per un documento, se questo documento è crittografato con la password. Può essere NULL o una stringa vuota, che equivale alla password assente. Per quei formati di documento che non dispongono di una funzione di protezione tramite password, questo argomento verrà ignorato. Se il documento è crittografato e la password non è specificata in questo parametro, ma è stata specificata prima nelle opzioni di caricamento durante la creazione di questoEditor esempio, verrà utilizzato. |
Valore di ritorno
Erede specifico del formato diIDocumentInfo
interface, che indica il formato rilevato con metadati specifici del formato o NULL, se il documento non è stato riconosciuto come supportabile o è danneggiato.
Eccezioni
eccezione | condizione |
---|---|
ObjectDisposedException | Viene generato quando l’istanza dell’editor è già stata eliminata quando viene richiamato “GetDocumentInfo”. |
PasswordRequiredException | Viene generato quando il documento caricato è protetto da password, ma la password non è stata specificata nel parametro “password” |
IncorrectPasswordException | Viene generato quando il documento caricato è protetto da password, la password è specificata, ma non è corretta |
InvalidOperationException | Viene generato quando si è verificato un errore imprevisto di natura sconosciuta |
Osservazioni
Il metodo GetDocumentInfo è utile quando non è chiaro quale formato sia il documento di input, se è protetto da password e/o quante pagine/fogli di lavoro/diapositive contiene. Sulla base di questi metadati, restituiti da GetDocumentInfo, è possibile regolare correttamente le opzioni di caricamento e modifica per la pipeline di elaborazione principale.
Il metodo GetDocumentInfo restituisce sempre i dati completi, non è influenzato dalla modalità di prova, il suo utilizzo non cancella i byte o i crediti consumati.
Saperne di più
- Ulteriori informazioni su come ottenere proprietà specifiche del documento in code: Come ottenere informazioni sul documento utilizzando GroupDocs.Editor
Guarda anche
- interface IDocumentInfo
- class Editor
- spazio dei nomi GroupDocs.Editor
- assemblea GroupDocs.Editor