FormField

FormField class

Representa un solo campo de formulario.

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

public class FormField : SpecialChar

Propiedades

NombreDescripción
CalculateOnExit { get; set; }Verdadero si las referencias al campo de formulario especificado se actualizan automáticamente cada vez que se sale del campo.
CheckBoxSize { get; set; }Obtiene o establece el tamaño de la casilla de verificación en puntos. Tiene efecto solo cuandoIsCheckBoxExactSize esverdadero .
Checked { get; set; }Obtiene o establece el estado marcado del campo de formulario de casilla de verificación. El valor predeterminado para esta propiedad esFALSO .
CustomNodeId { get; set; }Especifica un identificador de nodo personalizado.
Default { get; set; }Obtiene o establece el valor predeterminado del campo de formulario de casilla de verificación. El valor predeterminado para esta propiedad esFALSO .
virtual Document { get; }Obtiene el documento al que pertenece este nodo.
DropDownItems { get; }Proporciona acceso a los elementos de un campo de formulario desplegable.
DropDownSelectedIndex { get; set; }Obtiene o establece el índice que especifica el elemento seleccionado actualmente en un campo de formulario desplegable.
Enabled { get; set; }Verdadero si un campo de formulario está habilitado.
EntryMacro { get; set; }Devuelve o establece un nombre de macro de entrada para el campo de formulario.
ExitMacro { get; set; }Devuelve o establece un nombre de macro de salida para el campo de formulario.
Font { get; }Proporciona acceso al formato de fuente de este objeto.
HelpText { get; set; }Devuelve o establece el texto que se muestra en un cuadro de mensaje cuando el campo de formulario tiene el foco y el usuario presiona F1.
IsCheckBoxExactSize { get; set; }Obtiene o establece el valor booleano que indica si el tamaño del cuadro de texto es automático o se especifica explícitamente.
virtual IsComposite { get; }Devuelveverdadero si este nodo puede contener otros nodos.
IsDeleteRevision { get; }Devuelve verdadero si este objeto se eliminó en Microsoft Word mientras el seguimiento de cambios estaba habilitado.
IsFormatRevision { get; }Devuelve verdadero si se cambió el formato del objeto en Microsoft Word mientras estaba habilitado el seguimiento de cambios.
IsInsertRevision { get; }Devuelve verdadero si este objeto se insertó en Microsoft Word mientras el seguimiento de cambios estaba habilitado.
IsMoveFromRevision { get; }Devuelveverdadero Si este objeto se movió (eliminó) en Microsoft Word mientras el seguimiento de cambios estaba habilitado.
IsMoveToRevision { get; }Devuelveverdadero Si este objeto se movió (insertó) en Microsoft Word mientras el seguimiento de cambios estaba habilitado.
MaxLength { get; set; }Longitud máxima del campo de texto. Cero si la longitud es ilimitada.
Name { get; set; }Obtiene o establece el nombre del campo de formulario.
NextSibling { get; }Obtiene el nodo inmediatamente siguiente a este nodo.
override NodeType { get; }DevuelveFormField .
OwnHelp { get; set; }Especifica la fuente del texto que se muestra en un cuadro de mensaje cuando un campo de formulario tiene el foco y el usuario presiona F1.
OwnStatus { get; set; }Especifica la fuente del texto que se muestra en la barra de estado cuando un campo de formulario tiene el foco.
ParentNode { get; }Obtiene el padre inmediato de este nodo.
ParentParagraph { get; }Recupera el padreParagraph de este nodo.
PreviousSibling { get; }Obtiene el nodo inmediatamente anterior a este nodo.
Range { get; }Devuelve unRangeobjeto que representa la porción de un documento que está contenida en este nodo.
Result { get; set; }Obtiene o establece una cadena que representa el resultado de este campo de formulario.
StatusText { get; set; }Devuelve o establece el texto que se muestra en la barra de estado cuando un campo de formulario tiene el foco.
TextInputDefault { get; set; }Obtiene o establece la cadena predeterminada o una expresión de cálculo de un campo de formulario de texto.
TextInputFormat { get; set; }Devuelve o establece el formato de texto para un campo de formulario de texto.
TextInputType { get; set; }Obtiene o establece el tipo de un campo de formulario de texto.
Type { get; }Devuelve el tipo de campo de formulario.

Métodos

NombreDescripción
override Accept(DocumentVisitor)Acepta un visitante.
Clone(bool)Crea un duplicado del nodo.
GetAncestor(NodeType)Obtiene el primer ancestro del especificadoNodeType .
GetAncestor(Type)Obtiene el primer ancestro del tipo de objeto especificado.
override GetText()Obtiene el carácter especial que representa este nodo.
NextPreOrder(Node)Obtiene el siguiente nodo según el algoritmo de recorrido del árbol de preorden.
PreviousPreOrder(Node)Obtiene el nodo anterior según el algoritmo de recorrido del árbol de preorden.
Remove()Se elimina a sí mismo del padre.
RemoveField()Elimina el campo de formulario completo, no sólo el carácter especial del campo de formulario.
SetTextInputValue(object)Aplica el formato de texto especificado enTextInputFormat y almacena el valor enResult .
ToString(SaveFormat)Exporta el contenido del nodo en una cadena en el formato especificado.
ToString(SaveOptions)Exporta el contenido del nodo en una cadena utilizando las opciones de guardado especificadas.

Observaciones

Microsoft Word proporciona los siguientes campos de formulario: casilla de verificación, entrada de texto y menú desplegable (cuadro combinado).

FormField es un nodo en línea y solo puede ser un hijo deParagraph.

FormField se representa en un documento mediante un carácter especial and posicionado como un carácter dentro de una línea de texto.

Un campo de formulario completo en un documento de Word es una estructura compleja representada por varios nodos: inicio, código (como FORMTEXT), datos, separador, resultado, fin y marcador. Para crear campos de formulario en un documento de Word mediante programación, utiliceInsertCheckBox , InsertTextInput y InsertComboBoxwhich asegúrese de que todos los nodos del campo de formulario se creen en un orden correcto y en un estado adecuado.

Ejemplos

Muestra cómo formatear todo el FormField, incluido el valor del campo.

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

FormField formField = doc.Range.FormFields[0];
formField.Font.Bold = true;
formField.Font.Size = 24;
formField.Font.Color = Color.Red;

formField.Result = "Aspose.FormField";

doc = DocumentHelper.SaveOpen(doc);

Run formFieldRun = doc.FirstSection.Body.FirstParagraph.Runs[1];

Assert.AreEqual("Aspose.FormField", formFieldRun.Text);
Assert.AreEqual(true, formFieldRun.Font.Bold);
Assert.AreEqual(24, formFieldRun.Font.Size);
Assert.AreEqual(Color.Red.ToArgb(), formFieldRun.Font.Color.ToArgb());

Muestra cómo insertar un cuadro combinado.

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

builder.Write("Please select a fruit: ");

// Inserte un cuadro combinado que permitirá al usuario elegir una opción de una colección de cadenas.
FormField comboBox = builder.InsertComboBox("MyComboBox", new[] { "Apple", "Banana", "Cherry" }, 0);

Assert.AreEqual("MyComboBox", comboBox.Name);
Assert.AreEqual(FieldType.FieldFormDropDown, comboBox.Type);
Assert.AreEqual("Apple", comboBox.Result);

//El campo de formulario aparecerá en forma de una etiqueta html "select".
doc.Save(ArtifactsDir + "FormFields.Create.html");

Ver también