7 Appendix

This section describes the Document Element classes that represent an Application Programming Interface (API) for implementing a Content Generator. Each subsection describes the class for each Document Element Type along with an example implementation and helpful information for the use of each.

// create table with 4 rows and 4 columns
TableDocumentElement tableElement = (TableDocumentElement) this.Factory.NewTable(“table”, 4, 4);
// or this.Factory.NewTable();
// or this.Factory.NewTable(“table”);
// merge first cell to the right
tableElement.MergeCells(0, 0, MergeDirection.Right);
// merge third cell in the second row to the left, twice
tableElement.MergeCells(1, 2, MergeDirection.Left);
tableElement.MergeCells(1, 2, 3);
// merge last cell in second row with cell below, twice
tableElement.MergeCells(1, 3, MergeDirection.Down);
tableElement.MergeCells(1, 3, 2);
// unmerge first cell
tableElement.UnmergeCells(0, 0);
// delete last row deletion
tableElement.RemoveRow(tableElement.RowCount - 1);
// add new row at the end
tableElement.AddRow();
// add new row at the beginning
tableElement.AddRow(0);
// add new column at the end
tableElement.AddColumn();
// add new column before the second
tableElement.AddColumn(1);
// remove third column
tableElement.RemoveColumn(2);
targetElement.AddChild(tableElement);

• If table element Name is not explicitly passed in the NewTable() constructor, then first appropriate schema element will be used.
• Factory method NewTable() takes as parameters rowCount and columnCount values. If these parameters are omitted, then table will be created with 2 rows and columns (default value).
• In methods like AddRow(), AddColumn(), RemoveRow() and etc., Index parameter can be omitted. In this case method will be applied to the last row or column. Table must have at least one row and column.
• In method MergeCells() parameter mergeDirection can take one of the enumeration values: (MergeDirection.Up,MergeDirection.Right, MergeDirection.Down, MergeDirection.Left) or integer value (0, 1, 2, 3), numbers correspond to the enumeration.

ListDocumentElement listElement = (ListDocumentElement) this.Factory.NewList(“list1", 3);
// or this.Factory.NewList();
// or this.Factory.NewList(“list1");
// set list style
listElement.ListType = ListTypes.Numeric;
// create new list item at the end
listElement.AddItem();
// create new list item at the beginning
listElement.AddItem(0);
// remove second item
listElement.RemoveItem(1);
targetElement.AddChild(listElement);

• If list element Name isn’t passed in NewList() constructor, then first appropriate schema element will be used.
• Factory method NewList() takes as a second parameter itemCount value. If this parameter is omitted and there is no information about default children count in the schema definition, then list will be empty (there is no default value).
• In methods AddItem(), RemoveItem() parameter Index can be omitted. In this case method will be applied to the last list Item.
• Property ListType can take one of the following enumeration values: ListTypes.Bullet, ListTypes.Numeric, ListTypes.Alpha.

// create text element with «Hello World!» content
TextDocumentElement textElement = (TextDocumentElement) this.Factory.NewText(“ptxt”,
“Initial Text!\n”);
// or this.Factory.NewText();
// or this.Factory.NewText(“ptxt”);
// replace all existing strings with a new one
textElement.Text = “Hello, World!\n";
// add new string
textElement.AddString(“How are you, World?\n”);
// add new string with «italic» style
textElement.AddString(“Bye, World!\n”, “bold”);
// set style for second string
textElement.Strings[1].SetStyle(“italic bold under strike”);
// set style for substring
textElement.Strings[2].SetStyle(“sub”, 3, 7);
// set link on element of another document (root element in this case)
textElement.Strings[4].SetLink(“1D93C56E1EBA4F6A9B68D348444C9C17",
“1D93C56E1EBA4F6A9B68D348444C9C17");
// remove link
textElement.Strings[4].RemoveLink();
targetElement.AddChild(textElement);

• Factory method NewText() has an optional second parameter initialText value.
• Text Document Elements contain StringDocumentElements as its children. Separate StringDocumentElements can be obtained with indexer property Strings.
  StringDocumentElement stringElement = textElement.Strings[1];
  o StringCount property identifies the number of StringDocumentElements.
• Property Text returns concatenated content of all strings of the TextDocumentElement. If property used as a setter, then all current strings will be replaced by the given string.
• Method SetStyle() of StringDocumentElement takes text Style string as a parameter. It contains desired styles, which are delimited by the ‘space’ character. Additionally the SetStyle() method can take startRange and endRange parameters, in this case string may be split on substrings and total number of strings in the TextDocumentElement will be increased.
  // after this command, the number of strings in the text Element will increase to two
  textElement.Strings[2].SetStyle(“sub”, 3, 7);
• Method SetLink() takes targetBlockId (id of existing Technical Document) and targetElementId (id of any element in this Document). Currently will work properly for root document element and its children.

ImageDocumentElement imageElement = (ImageDocumentElement) this.Factory.NewElement(“graphic”);
// get tp_Image item from Innovator
Item imageItem = this.Factory.InnovatorInstance.newItem(“tp_Image”, “get”);
imageItem.setID(“70CA6215D95C4658ACA68BFDB73E4DEE”);
imageItem = imageItem.apply();
// set reference on image item
imageElement.SetImage(imageItem);
targetElement.AddChild(imageElement);

• Currently there is no explicit constructor for ImageDocumentElement in SchemaElementFactory. It should be created with base element constructor (Factory.NewElement).
• By default, ImageDocumentElements are empty. Method SetImage() can be used to set the image Item reference and takes an Item as a parameter. Currently ImageDocumentElements can have refences only to tp_Image Items.

ItemDocumentElement itemElement = (ItemDocumentElement) this.Factory.NewElement(“aras-part”);
// get item from Innovator
Item itemItem = this.Factory.InnovatorInstance.newItem(“Part”, “get”);
itemItem.setID(“CD2B48A0C3C042898AC00254930FC8A1");
itemItem = itemItem.apply();
// set item reference
itemElement.SetItem(itemItem);
targetElement.AddChild(itemElement);

• Currently there is no explicit constructor for ItemDocumentElement in SchemaElementFactory. It should be created with base element constructor (Factory.NewElement).
• By default, ItemDocumentElements are empty. Method SetItem()can be used to set the Item reference and takes an Item as a parameter. Currently ItemDocumentElements can have refences only to tp_Item Polysource Items.

Item partItem = bomItem.getPropertyItem(“related_id”);
ItemDocumentElement itemElement = (ItemDocumentElement)this.Factory.NewElement(“PartItemRow”);
// set item reference
itemElement.SetItem(partItem);
ItemPropertyDocumentElement nameText = (ItemPropertyDocumentElement) this.Factory.NewItemProperty(“NameProperty”, “name”);
…
itemElement.AddChild(nameText);

• This example adds an ItemPropertyDocumentElement based on the following Schema Definition:
  
  Expand Collapse

  <xs:element name="NameProperty">
  
  <xs:complexType>
  
  <xs:complexContent>
  
  <xs:extension base="aras:itemProperty">
  
  <xs:attribute name="property" type="xs:string" fixed="name"/>
  
  <xs:attribute name="mode" type="aras:itemPropertyModeEnum" fixed="write"/>
  
  </xs:extension>
  
  </xs:complexContent>
  
  </xs:complexType>
  
  </xs:element>
  
  

• Note that in the example above, the property attribute is fixed for the ‘name’ Property and the mode is fixed to ‘write’. These are optional in the schema although it’s useful to define default values.
• The example above includes the name of the Property in the NewItemProperty method. This is required even though it was defaulted to a value in the schema.