com.aspose.words
Class ToaCategories

java.lang.Object
    extended by com.aspose.words.ToaCategories

public class ToaCategories 
extends java.lang.Object

Represents a table of authorities categories.

Example:

Shows how to specify a set of categories for TOA fields.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// TOA fields can filter their entries by categories defined in this collection.
ToaCategories toaCategories = new ToaCategories();
doc.getFieldOptions().setToaCategories(toaCategories);

// This collection of categories comes with default values, which we can overwrite with custom values.
Assert.assertEquals("Cases", toaCategories.get(1));
Assert.assertEquals("Statutes", toaCategories.get(2));

toaCategories.set(1, "My Category 1");
toaCategories.set(2, "My Category 2");

// We can always access the default values via this collection.
Assert.assertEquals("Cases", ToaCategories.getDefaultCategories().get(1));
Assert.assertEquals("Statutes", ToaCategories.getDefaultCategories().get(2));

// Insert 2 TOA fields. TOA fields create an entry for each TA field in the document.
// Use the "\c" switch to select the index of a category from our collection.
//  With this switch, a TOA field will only pick up entries from TA fields that
// also have a "\c" switch with a matching category index. Each TOA field will also display
// the name of the category that its "\c" switch points to.
builder.insertField("TOA \\c 1 \\h", null);
builder.insertField("TOA \\c 2 \\h", null);
builder.insertBreak(BreakType.PAGE_BREAK);

// Insert TOA entries across 2 categories. Our first TOA field will receive one entry,
// from the second TA field whose "\c" switch also points to the first category.
// The second TOA field will have two entries from the other two TA fields.
builder.insertField("TA \\c 2 \\l \"entry 1\"");
builder.insertBreak(BreakType.PAGE_BREAK);
builder.insertField("TA \\c 1 \\l \"entry 2\"");
builder.insertBreak(BreakType.PAGE_BREAK);
builder.insertField("TA \\c 2 \\l \"entry 3\"");

doc.updateFields();
doc.save(getArtifactsDir() + "FieldOptions.TOA.Categories.docx");

Constructor Summary
ToaCategories()
          
 
Property Getters/Setters Summary
static ToaCategoriesgetDefaultCategories()
           Gets the default table of authorities categories.
java.lang.Stringget(int number)
voidset(int number, java.lang.String value)
           Gets or sets the category heading by category number.
 

Constructor Detail

ToaCategories

public ToaCategories()

Property Getters/Setters Detail

getDefaultCategories

public static ToaCategories getDefaultCategories()
Gets the default table of authorities categories. Use the FieldOptions.ToaCategories property to specify table of authorities categories for a single document.

Example:

Shows how to specify a set of categories for TOA fields.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// TOA fields can filter their entries by categories defined in this collection.
ToaCategories toaCategories = new ToaCategories();
doc.getFieldOptions().setToaCategories(toaCategories);

// This collection of categories comes with default values, which we can overwrite with custom values.
Assert.assertEquals("Cases", toaCategories.get(1));
Assert.assertEquals("Statutes", toaCategories.get(2));

toaCategories.set(1, "My Category 1");
toaCategories.set(2, "My Category 2");

// We can always access the default values via this collection.
Assert.assertEquals("Cases", ToaCategories.getDefaultCategories().get(1));
Assert.assertEquals("Statutes", ToaCategories.getDefaultCategories().get(2));

// Insert 2 TOA fields. TOA fields create an entry for each TA field in the document.
// Use the "\c" switch to select the index of a category from our collection.
//  With this switch, a TOA field will only pick up entries from TA fields that
// also have a "\c" switch with a matching category index. Each TOA field will also display
// the name of the category that its "\c" switch points to.
builder.insertField("TOA \\c 1 \\h", null);
builder.insertField("TOA \\c 2 \\h", null);
builder.insertBreak(BreakType.PAGE_BREAK);

// Insert TOA entries across 2 categories. Our first TOA field will receive one entry,
// from the second TA field whose "\c" switch also points to the first category.
// The second TOA field will have two entries from the other two TA fields.
builder.insertField("TA \\c 2 \\l \"entry 1\"");
builder.insertBreak(BreakType.PAGE_BREAK);
builder.insertField("TA \\c 1 \\l \"entry 2\"");
builder.insertBreak(BreakType.PAGE_BREAK);
builder.insertField("TA \\c 2 \\l \"entry 3\"");

doc.updateFields();
doc.save(getArtifactsDir() + "FieldOptions.TOA.Categories.docx");

get/set

public java.lang.String get(int number) / public void set(int number, java.lang.String value)
Gets or sets the category heading by category number.

Example:

Shows how to specify a set of categories for TOA fields.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// TOA fields can filter their entries by categories defined in this collection.
ToaCategories toaCategories = new ToaCategories();
doc.getFieldOptions().setToaCategories(toaCategories);

// This collection of categories comes with default values, which we can overwrite with custom values.
Assert.assertEquals("Cases", toaCategories.get(1));
Assert.assertEquals("Statutes", toaCategories.get(2));

toaCategories.set(1, "My Category 1");
toaCategories.set(2, "My Category 2");

// We can always access the default values via this collection.
Assert.assertEquals("Cases", ToaCategories.getDefaultCategories().get(1));
Assert.assertEquals("Statutes", ToaCategories.getDefaultCategories().get(2));

// Insert 2 TOA fields. TOA fields create an entry for each TA field in the document.
// Use the "\c" switch to select the index of a category from our collection.
//  With this switch, a TOA field will only pick up entries from TA fields that
// also have a "\c" switch with a matching category index. Each TOA field will also display
// the name of the category that its "\c" switch points to.
builder.insertField("TOA \\c 1 \\h", null);
builder.insertField("TOA \\c 2 \\h", null);
builder.insertBreak(BreakType.PAGE_BREAK);

// Insert TOA entries across 2 categories. Our first TOA field will receive one entry,
// from the second TA field whose "\c" switch also points to the first category.
// The second TOA field will have two entries from the other two TA fields.
builder.insertField("TA \\c 2 \\l \"entry 1\"");
builder.insertBreak(BreakType.PAGE_BREAK);
builder.insertField("TA \\c 1 \\l \"entry 2\"");
builder.insertBreak(BreakType.PAGE_BREAK);
builder.insertField("TA \\c 2 \\l \"entry 3\"");

doc.updateFields();
doc.save(getArtifactsDir() + "FieldOptions.TOA.Categories.docx");

See Also:
          Aspose.Words Documentation - the home page for the Aspose.Words Product Documentation.
          Aspose.Words Support Forum - our preferred method of support.