FieldFormat Class |
The FieldFormat type exposes the following members.
Name | Description | |
---|---|---|
![]() ![]() | DateTimeFormat |
Gets or sets a formatting that is applied to a date and time field result. Corresponds to the \@ switch.
|
![]() ![]() | GeneralFormats |
Gets a collection of general formats that are applied to a numeric, text or any field result.
Corresponds to the \* switches.
|
![]() ![]() | NumericFormat |
Gets or sets a formatting that is applied to a numeric field result. Corresponds to the \# switch.
|
Name | Description | |
---|---|---|
![]() | Equals | (Inherited from Object.) |
![]() | GetHashCode | (Inherited from Object.) |
![]() | GetType | (Inherited from Object.) |
![]() | ToString | (Inherited from Object.) |
Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Use a document builder to insert a field that displays a result with no format applied. Field field = builder.InsertField("= 2 + 3"); Assert.AreEqual("= 2 + 3", field.GetFieldCode()); Assert.AreEqual("5", field.Result); // We can apply a format to a field's result using the field's properties. // Below are three types of formats that we can apply to a field's result. // 1 - Numeric format: FieldFormat format = field.Format; format.NumericFormat = "$###.00"; field.Update(); Assert.AreEqual("= 2 + 3 \\# $###.00", field.GetFieldCode()); Assert.AreEqual("$ 5.00", field.Result); // 2 - Date/time format: field = builder.InsertField("DATE"); format = field.Format; format.DateTimeFormat = "dddd, MMMM dd, yyyy"; field.Update(); Assert.AreEqual("DATE \\@ \"dddd, MMMM dd, yyyy\"", field.GetFieldCode()); Console.WriteLine($"Today's date, in {format.DateTimeFormat} format:\n\t{field.Result}"); // 3 - General format: field = builder.InsertField("= 25 + 33"); format = field.Format; format.GeneralFormats.Add(GeneralFormat.LowercaseRoman); format.GeneralFormats.Add(GeneralFormat.Upper); field.Update(); int index = 0; using (IEnumerator<GeneralFormat> generalFormatEnumerator = format.GeneralFormats.GetEnumerator()) while (generalFormatEnumerator.MoveNext()) Console.WriteLine($"General format index {index++}: {generalFormatEnumerator.Current}"); Assert.AreEqual("= 25 + 33 \\* roman \\* Upper", field.GetFieldCode()); Assert.AreEqual("LVIII", field.Result); Assert.AreEqual(2, format.GeneralFormats.Count); Assert.AreEqual(GeneralFormat.LowercaseRoman, format.GeneralFormats[0]); // We can remove our formats to revert the field's result to its original form. format.GeneralFormats.Remove(GeneralFormat.LowercaseRoman); format.GeneralFormats.RemoveAt(0); Assert.AreEqual(0, format.GeneralFormats.Count); field.Update(); Assert.AreEqual("= 25 + 33 ", field.GetFieldCode()); Assert.AreEqual("58", field.Result); Assert.AreEqual(0, format.GeneralFormats.Count);