## FieldTA class

Implements the TA field.

To learn more, visit the [Working with Fields](https://docs.aspose.com/words/net/working-with-fields/) documentation article.

```csharp
public class FieldTA : Field
```

## Constructors

| Name | Description |
| --- | --- |
| [FieldTA](fieldta/)() | The default constructor. |

## Properties

| Name | Description |
| --- | --- |
| [DisplayResult](../../aspose.words.fields/field/displayresult/) { get; } | Gets the text that represents the displayed field result. |
| [End](../../aspose.words.fields/field/end/) { get; } | Gets the node that represents the field end. |
| [EntryCategory](../../aspose.words.fields/fieldta/entrycategory/) { get; set; } | Gets or sets the integral entry category, which is a number that corresponds to the order of categories. |
| [Format](../../aspose.words.fields/field/format/) { get; } | Gets a [`FieldFormat`](../fieldformat/) object that provides typed access to field's formatting. |
| [IsBold](../../aspose.words.fields/fieldta/isbold/) { get; set; } | Gets or sets whether to apply bold formatting to the page number for the entry. |
| [IsDirty](../../aspose.words.fields/field/isdirty/) { get; set; } | Gets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document. |
| [IsItalic](../../aspose.words.fields/fieldta/isitalic/) { get; set; } | Gets or sets whether to apply italic formatting to the page number for the entry. |
| [IsLocked](../../aspose.words.fields/field/islocked/) { get; set; } | Gets or sets whether the field is locked (should not recalculate its result). |
| [LocaleId](../../aspose.words.fields/field/localeid/) { get; set; } | Gets or sets the LCID of the field. |
| [LongCitation](../../aspose.words.fields/fieldta/longcitation/) { get; set; } | Gets or sets the long citation for the entry. |
| [PageRangeBookmarkName](../../aspose.words.fields/fieldta/pagerangebookmarkname/) { get; set; } | Gets or sets the name of the bookmark that marks a range of pages that is inserted as the entry's page number. |
| [Result](../../aspose.words.fields/field/result/) { get; set; } | Gets or sets text that is between the field separator and field end. |
| [Separator](../../aspose.words.fields/field/separator/) { get; } | Gets the node that represents the field separator. Can be `null`. |
| [ShortCitation](../../aspose.words.fields/fieldta/shortcitation/) { get; set; } | Gets or sets the short citation for the entry. |
| [Start](../../aspose.words.fields/field/start/) { get; } | Gets the node that represents the start of the field. |
| virtual [Type](../../aspose.words.fields/field/type/) { get; } | Gets the Microsoft Word field type. |

## Methods

| Name | Description |
| --- | --- |
| [GetFieldCode](../../aspose.words.fields/field/getfieldcode/)() | Returns text between field start and field separator (or field end if there is no separator). Both field code and field result of child fields are included. |
| [GetFieldCode](../../aspose.words.fields/field/getfieldcode/)(*bool*) | Returns text between field start and field separator (or field end if there is no separator). |
| virtual [Remove](../../aspose.words.fields/field/remove/)() | Removes the field from the document. Returns a node right after the field. If the field's end is the last child of its parent node, returns its parent paragraph. If the field is already removed, returns `null`. |
| [Unlink](../../aspose.words.fields/field/unlink/)() | Performs the field unlink. |
| [Update](../../aspose.words.fields/field/update/)() | Performs the field update. Throws if the field is being updated already. |
| [Update](../../aspose.words.fields/field/update/)(*bool*) | Performs a field update. Throws if the field is being updated already. |

## Remarks

Defines the text and page number for a table of authorities entry, which is used by a TOA field.

## Examples

Shows how to build and customize a table of authorities using TOA and TA fields.

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

// Insert a TOA field, which will create an entry for each TA field in the document,
// displaying long citations and page numbers for each entry.
FieldToa fieldToa = (FieldToa)builder.InsertField(FieldType.FieldTOA, false);

// Set the entry category for our table. This TOA will now only include TA fields
// that have a matching value in their EntryCategory property.
fieldToa.EntryCategory = "1";

// Moreover, the Table of Authorities category at index 1 is "Cases",
// which will show up as our table's title if we set this variable to true.
fieldToa.UseHeading = true;

// We can further filter TA fields by naming a bookmark that they will need to be within the TOA bounds.
fieldToa.BookmarkName = "MyBookmark";

// By default, a dotted line page-wide tab appears between the TA field's citation
// and its page number. We can replace it with any text we put on this property.
// Inserting a tab character will preserve the original tab.
fieldToa.EntrySeparator = " \t p.";

// If we have multiple TA entries that share the same long citation,
// all their respective page numbers will show up on one row.
// We can use this property to specify a string that will separate their page numbers.
fieldToa.PageNumberListSeparator = " & p. ";

// We can set this to true to get our table to display the word "passim"
// if there are five or more page numbers in one row.
fieldToa.UsePassim = true;

// One TA field can refer to a range of pages.
// We can specify a string here to appear between the start and end page numbers for such ranges.
fieldToa.PageRangeSeparator = " to ";

// The format from the TA fields will carry over into our table.
// We can disable this by setting the RemoveEntryFormatting flag.
fieldToa.RemoveEntryFormatting = true;
builder.Font.Color = Color.Green;
builder.Font.Name = "Arial Black";

Assert.That(fieldToa.GetFieldCode(), Is.EqualTo(" TOA  \\c 1 \\h \\b MyBookmark \\e \" \t p.\" \\l \" & p. \" \\p \\g \" to \" \\f"));

builder.InsertBreak(BreakType.PageBreak);

// This TA field will not appear as an entry in the TOA since it is outside
// the bookmark's bounds that the TOA's BookmarkName property specifies.
FieldTA fieldTA = InsertToaEntry(builder, "1", "Source 1");

Assert.That(fieldTA.GetFieldCode(), Is.EqualTo(" TA  \\c 1 \\l \"Source 1\""));

// This TA field is inside the bookmark,
// but the entry category does not match that of the table, so the TA field will not include it.
builder.StartBookmark("MyBookmark");
fieldTA = InsertToaEntry(builder, "2", "Source 2");

// This entry will appear in the table.
fieldTA = InsertToaEntry(builder, "1", "Source 3");

// A TOA table does not display short citations,
// but we can use them as a shorthand to refer to bulky source names that multiple TA fields reference.
fieldTA.ShortCitation = "S.3";

Assert.That(fieldTA.GetFieldCode(), Is.EqualTo(" TA  \\c 1 \\l \"Source 3\" \\s S.3"));

// We can format the page number to make it bold/italic using the following properties.
// We will still see these effects if we set our table to ignore formatting.
fieldTA = InsertToaEntry(builder, "1", "Source 2");
fieldTA.IsBold = true;
fieldTA.IsItalic = true;

Assert.That(fieldTA.GetFieldCode(), Is.EqualTo(" TA  \\c 1 \\l \"Source 2\" \\b \\i"));

// We can configure TA fields to get their TOA entries to refer to a range of pages that a bookmark spans across.
// Note that this entry refers to the same source as the one above to share one row in our table.
// This row will have the page number of the entry above and the page range of this entry,
// with the table's page list and page number range separators between page numbers.
fieldTA = InsertToaEntry(builder, "1", "Source 3");
fieldTA.PageRangeBookmarkName = "MyMultiPageBookmark";

builder.StartBookmark("MyMultiPageBookmark");
builder.InsertBreak(BreakType.PageBreak);
builder.InsertBreak(BreakType.PageBreak);
builder.InsertBreak(BreakType.PageBreak);
builder.EndBookmark("MyMultiPageBookmark");

Assert.That(fieldTA.GetFieldCode(), Is.EqualTo(" TA  \\c 1 \\l \"Source 3\" \\r MyMultiPageBookmark"));

// If we have enabled the "Passim" feature of our table, having 5 or more TA entries with the same source will invoke it.
for (int i = 0; i < 5; i++)
{
    InsertToaEntry(builder, "1", "Source 4");
}

builder.EndBookmark("MyBookmark");

doc.UpdateFields();
doc.Save(ArtifactsDir + "Field.TOA.TA.docx");
```

Shows how to build and customize a table of authorities using TOA and TA fields (InsertToaEntry).

```csharp
private static FieldTA InsertToaEntry(DocumentBuilder builder, string entryCategory, string longCitation)
{
    FieldTA field = (FieldTA)builder.InsertField(FieldType.FieldTOAEntry, false);
    field.EntryCategory = entryCategory;
    field.LongCitation = longCitation;

    builder.InsertBreak(BreakType.PageBreak);

    return field;
}
```

### See Also

* class [Field](../field/)
* namespace [Aspose.Words.Fields](../../aspose.words.fields/)
* assembly [Aspose.Words](../../)