FieldFileSize

FieldFileSize class

Implémente le champ FILESIZE.

Pour en savoir plus, visitez leTravailler avec des champs article documentaire.

public class FieldFileSize : Field

Constructeurs

NomLa description
FieldFileSize()Default_Constructor

Propriétés

NomLa description
DisplayResult { get; }Obtient le texte qui représente le résultat du champ affiché.
End { get; }Obtient le nœud qui représente la fin du champ.
Format { get; }Obtient unFieldFormat objet qui fournit un accès typé au formatage du champ.
IsDirty { get; set; }Obtient ou définit si le résultat actuel du champ n’est plus correct (périmé) en raison d’autres modifications apportées au document.
IsInKilobytes { get; set; }Obtient ou définit s’il faut afficher la taille du fichier en kilo-octets.
IsInMegabytes { get; set; }Obtient ou définit s’il faut afficher la taille du fichier en mégaoctets.
IsLocked { get; set; }Obtient ou définit si le champ est verrouillé (ne doit pas recalculer son résultat).
LocaleId { get; set; }Obtient ou définit le LCID du champ.
Result { get; set; }Obtient ou définit le texte situé entre le séparateur de champ et la fin du champ.
Separator { get; }Obtient le nœud qui représente le séparateur de champ. Peut êtrenul .
Start { get; }Obtient le nœud qui représente le début du champ.
virtual Type { get; }Obtient le type de champ Microsoft Word.

Méthodes

NomLa description
GetFieldCode()Renvoie le texte entre le début du champ et le séparateur de champ (ou la fin du champ s’il n’y a pas de séparateur). Le code de champ et le résultat du champ des champs enfants sont inclus.
GetFieldCode(bool)Renvoie le texte entre le début du champ et le séparateur de champ (ou la fin du champ s’il n’y a pas de séparateur).
Remove()Supprime le champ du document. Renvoie un nœud juste après le champ. Si la fin du champ est le dernier child de son nœud parent, renvoie son paragraphe parent. Si le champ est déjà supprimé, renvoienul .
Unlink()Effectue la dissociation du champ.
Update()Effectue la mise à jour du champ. Lance si le champ est déjà mis à jour.
Update(bool)Effectue une mise à jour du champ. Lance si le champ est déjà mis à jour.

Remarques

Récupère la taille du fichier du document actuel ou 0 si la taille ne peut pas être déterminée.

Dans l’implémentation actuelle, utilise leOriginalFileName propriété pour récupérer le nom de fichier utilisé pour déterminer la taille du fichier.

Exemples

Montre comment afficher la taille de fichier d’un document avec un champ FILESIZE.

Document doc = new Document(MyDir + "Document.docx");

Assert.AreEqual(18105, doc.BuiltInDocumentProperties.Bytes);

DocumentBuilder builder = new DocumentBuilder(doc);
builder.MoveToDocumentEnd();
builder.InsertParagraph();

// Vous trouverez ci-dessous trois unités de mesure différentes
// avec lequel les champs FILESIZE peuvent afficher la taille du fichier du document.
// 1 - Octets :
FieldFileSize field = (FieldFileSize)builder.InsertField(FieldType.FieldFileSize, true);
field.Update();

Assert.AreEqual(" FILESIZE ", field.GetFieldCode());
Assert.AreEqual("18105", field.Result);

// 2 - Kilooctets :
builder.InsertParagraph();
field = (FieldFileSize)builder.InsertField(FieldType.FieldFileSize, true);
field.IsInKilobytes = true;
field.Update();

Assert.AreEqual(" FILESIZE  \\k", field.GetFieldCode());
Assert.AreEqual("18", field.Result);

// 3 - Mégaoctets :
builder.InsertParagraph();
field = (FieldFileSize)builder.InsertField(FieldType.FieldFileSize, true);
field.IsInMegabytes = true;
field.Update();

Assert.AreEqual(" FILESIZE  \\m", field.GetFieldCode());
Assert.AreEqual("0", field.Result);

// Pour mettre à jour les valeurs de ces champs lors de l'édition dans Microsoft Word,
// nous devons d'abord enregistrer les modifications, puis mettre à jour manuellement ces champs.
doc.Save(ArtifactsDir + "Field.FILESIZE.docx");

Voir également

FieldFileName Class FieldFillIn Class