FieldComments

FieldComments class

Implementa el campo COMENTARIOS.

Para obtener más información, visite elTrabajar con campos artículo de documentación.

public class FieldComments : Field

Constructores

NombreDescripción
FieldComments()Constructor predeterminado

Propiedades

NombreDescripción
DisplayResult { get; }Obtiene el texto que representa el resultado del campo mostrado.
End { get; }Obtiene el nodo que representa el final del campo.
Format { get; }Obtiene unFieldFormat objeto que proporciona acceso escrito al formato del campo.
IsDirty { get; set; }Obtiene o establece si el resultado actual del campo ya no es correcto (obsoleto) debido a otras modificaciones realizadas en el documento.
IsLocked { get; set; }Obtiene o establece si el campo está bloqueado (no debe volver a calcular su resultado).
LocaleId { get; set; }Obtiene o establece el LCID del campo.
Result { get; set; }Obtiene o establece el texto que se encuentra entre el separador de campo y el final del campo.
Separator { get; }Obtiene el nodo que representa el separador de campos. Puede sernulo .
Start { get; }Obtiene el nodo que representa el inicio del campo.
Text { get; set; }Obtiene o establece el texto de los comentarios.
virtual Type { get; }Obtiene el tipo de campo de Microsoft Word.

Métodos

NombreDescripción
GetFieldCode()Devuelve texto entre el inicio del campo y el separador de campo (o el final del campo si no hay separador). Se incluyen tanto el código de campo como el resultado del campo de los campos secundarios.
GetFieldCode(bool)Devuelve texto entre el inicio del campo y el separador de campo (o el final del campo si no hay separador).
Remove()Elimina el campo del documento. Devuelve un nodo justo después del campo. Si el final del campo es el último hijo de su nodo principal, devuelve su párrafo principal. Si el campo ya está eliminado, devuelvenulo .
Unlink()Realiza la desvinculación del campo.
Update()Realiza la actualización del campo. Se produce si el campo ya se está actualizando.
Update(bool)Realiza una actualización de campo. Se produce si el campo ya se está actualizando.

Observaciones

Recupera y, opcionalmente, establece los comentarios relacionados con el documento actual, tal como se registra en elComments property de las propiedades del documento integrado.

Ejemplos

Muestra cómo utilizar el campo COMENTARIOS.

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Establece un valor para la propiedad integrada "Comentarios" del documento.
doc.BuiltInDocumentProperties.Comments = "My comment.";

// Cree un campo COMENTARIOS para mostrar el valor de esa propiedad incorporada.
FieldComments field = (FieldComments)builder.InsertField(FieldType.FieldComments, true);
field.Update();

Assert.AreEqual(" COMMENTS ", field.GetFieldCode());
Assert.AreEqual("My comment.", field.Result);

// Si damos el valor de la propiedad Texto del campo COMENTARIOS y lo actualizamos, el campo
// sobrescribe el valor actual de la propiedad incorporada "Comentarios" con el valor de su propiedad Texto,
// y luego mostrar el nuevo valor.
field.Text = "My overriding comment.";
field.Update();

Assert.AreEqual(" COMMENTS  \"My overriding comment.\"", field.GetFieldCode());
Assert.AreEqual("My overriding comment.", field.Result);

doc.Save(ArtifactsDir + "Field.COMMENTS.docx");

Ver también