DocumentFormatInstance

DocumentFormatInstance class

Représente un format spécifique d’un document. Implémentez cette classe pour ajouter vos propres types de documents.

public abstract class DocumentFormatInstance

Propriétés

Nom La description
Password { get; set; } Obtient ou définit un mot de passe pour les documents protégés par mot de passe.

Méthodes

Nom La description
virtual Initialize(DocumentFormatConfiguration, RedactorSettings) Effectue l’initialisation de l’instance du gestionnaire de format de document.
IsRedactionAccepted(RedactionDescription) VérifieIRedactionCallback implémentation et l’invoque, si spécifié.
virtual Load(Stream) Charge le document à partir d’un flux.
virtual PerformBinaryCheck(Stream) Vérifie si le flux donné contient un document, pris en charge par cette instance de format.
abstract Save(Stream) Enregistre le document dans un flux.

Remarques

Apprendre encore plus

Exemples

L’exemple suivant montre comment créer un stub vide pour un gestionnaire de format personnalisé.

L’exemple suivant montre comment utiliser les données d’initialisation.

public class DummyDocument : DocumentFormatInstance
{     
    public override void Load(Stream output)
    {
        // charge le contenu du fichier
    }

    public override void Save(Stream output)
    {
        // enregistre les modifications dans le fichier ;
    }
}

public class MyCustomHandler : DocumentFormatInstance
{
    private string MyProperty { get; set; }
    
    // Autre code personnalisé 
    ...

    public override void Initialize(DocumentFormatConfiguration config)
    {
        base.Initialize(config);
        if (config.InitializationData.ContainsKey("MyProperty"))
        {
            MyProperty = config.InitializationData["MyProperty"];
        }
    }
}

// Insertion d'un format personnalisé dans GroupDocs.Redaction
var mySettings = new DocumentFormatConfiguration();
mySettings.ExtensionFilter = ".foo";
mySettings.DocumentType = typeof(MyCustomHandler);
mySettings.InitializationData.Add("MyProperty", "bar");
var configuration = RedactorConfiguration.GetInstance();
configuration.AvailableFormats.Add(mySettings);

Voir également

IAnnotatedDocument