com.aspose.words.TabStopCollection
java.lang.Object
com.aspose.words.TabStopCollection
public class TabStopCollection
In Microsoft Word documents, a tab stop can be defined in the properties of a paragraph
style or directly in the properties of a paragraph. A style can be based on another style.
Therefore, the complete set of tab stops for a given object is a combination of tab stops
defined directly on this object and tab stops inherited from the parent styles. In Aspose.Words, when you obtain a TabStops collection for a paragraph or a style,
it contains only the custom tab stops defined directly for this paragraph or style.
The collection does not include tab stops defined in the parent styles or default tab stops.
| Property Getters/Setters Summary | ||
|---|---|---|
int | getCount() | |
| Gets the number of tab stops in the collection. | ||
TabStop | get(double position) | |
| Gets a tab stop at the specified position. | ||
TabStop | get(int index) | |
| Gets a tab stop at the given index. | ||
| Method Summary | ||
|---|---|---|
void | add(TabStop tabStop) | |
| Adds or replaces a tab stop in the collection. | ||
void | add(double position, int alignment, int leader) | |
| Adds or replaces a tab stop in the collection. | ||
TabStop | after(double position) | |
| Gets a first tab stop to the right of the specified position. | ||
TabStop | before(double position) | |
| Gets a first tab stop to the left of the specified position. | ||
void | clear() | |
| Deletes all tab stop positions. | ||
boolean | equals(java.lang.Object obj) | |
| Determines whether the specified object is equal in value to the current object. | ||
int | getIndexByPosition(double position) | |
| Gets the index of a tab stop with the specified position in points. | ||
double | getPositionByIndex(int index) | |
| Gets the position (in points) of the tab stop at the specified index. | ||
int | hashCode() | |
| Serves as a hash function for this type. | ||
void | removeByIndex(int index) | |
| Removes a tab stop at the specified index from the collection. | ||
void | removeByPosition(double position) | |
| Removes a tab stop at the specified position from the collection. | ||
| Property Getters/Setters Detail |
|---|
getCount | |
public int getCount() | |
get | |
public TabStop get(double position) | |
position - The position (in points) of the tab stop.get | |
public TabStop get(int index) | |
index - An index into the collection of tab stops.| Method Detail |
|---|
add | |
public void add(TabStop tabStop) | |
If a tab stop already exists at the specified position, it is replaced.
tabStop - A tab stop object to add.add | |
public void add(double position, int alignment, int leader) | |
If a tab stop already exists at the specified position, it is replaced.
position - A position (in points) where to add the tab stop.alignment - A leader - A after | |
public TabStop after(double position) | |
Skips tab stops with Alignment set to TabAlignment.Bar.
position - The reference position (in points).before | |
public TabStop before(double position) | |
Skips tab stops with Alignment set to TabAlignment.Bar.
position - The reference position (in points).clear | |
public void clear() | |
equals | |
public boolean equals(java.lang.Object obj) | |
getIndexByPosition | |
public int getIndexByPosition(double position) | |
getPositionByIndex | |
public double getPositionByIndex(int index) | |
index - An index into the collection of tab stops.hashCode | |
public int hashCode() | |
removeByIndex | |
public void removeByIndex(int index) | |
index - An index into the collection of tab stops.removeByPosition | |
public void removeByPosition(double position) | |
position - The position (in points) of the tab stop to remove.Example:
Shows how to modify the position of the right tab stop in TOC related paragraphs.
Document doc = new Document(getMyDir() + "Document.TableOfContents.doc");
// Iterate through all paragraphs in the document
for (Paragraph para : (Iterable<Paragraph>) doc.getChildNodes(NodeType.PARAGRAPH, true))
{
// Check if this paragraph is formatted using the TOC result based styles. This is any style between TOC and TOC9.
if (para.getParagraphFormat().getStyle().getStyleIdentifier() >= StyleIdentifier.TOC_1 && para.getParagraphFormat().getStyle().getStyleIdentifier() <= StyleIdentifier.TOC_9)
{
// Get the first tab used in this paragraph, this should be the tab used to align the page numbers.
TabStop tab = para.getParagraphFormat().getTabStops().get(0);
// Remove the old tab from the collection.
para.getParagraphFormat().getTabStops().removeByPosition(tab.getPosition());
// Insert a new tab using the same properties but at a modified position.
// We could also change the separators used (dots) by passing a different Leader type
para.getParagraphFormat().getTabStops().add(tab.getPosition() - 50, tab.getAlignment(), tab.getLeader());
}
}
doc.save(getMyDir() + "Document.TableOfContentsTabStops Out.doc");