API Reference
Class
WordFieldBuilder
Provides a fluent builder for constructing field codes including nested fields.
Inheritance
- WordFieldCode
- WordFieldBuilder
Constructors
public WordFieldBuilder(WordFieldType fieldType) #Initializes a new instance for the specified WordFieldType.
Parameters
- fieldType OfficeIMO.Word.WordFieldType
Methods
AddInstruction 2 overloads
public WordFieldBuilder AddInstruction(String instruction, Boolean quoted = false) #Returns:
WordFieldBuilderAdds an instruction to the field code.
Parameters
- instruction System.String
- Instruction to append.
- quoted System.Boolean = false
- When true, the instruction is wrapped in quotes.
Returns
The current WordFieldBuilder.
public WordFieldBuilder AddInstruction(WordFieldBuilder field) #Returns:
WordFieldBuilderAdds a nested field as an instruction.
Parameters
- field OfficeIMO.Word.WordFieldBuilder
- Nested field builder.
Returns
The current WordFieldBuilder.
public WordFieldBuilder AddSwitch(String value) #Returns:
WordFieldBuilderAdds a switch to the field code.
Parameters
- value System.String
- Switch string including leading backslash.
Returns
The current WordFieldBuilder.
public WordFieldBuilder SetCustomFormat(String format) #Returns:
WordFieldBuilderSets a custom date or time format.
Parameters
- format System.String
- Custom format string.
Returns
The current WordFieldBuilder.
public WordFieldBuilder SetFormat(WordFieldFormat format) #Returns:
WordFieldBuilderApplies a format switch to the field code.
Parameters
- format OfficeIMO.Word.WordFieldFormat
- Format switch to apply.
Returns
The current WordFieldBuilder.
Inherited Methods
public override Boolean Equals(Object obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object