com.aspose.words

Class FieldStyleRef

java.lang.Object

com.aspose.words.Field

com.aspose.words.FieldStyleRef

public class FieldStyleRef
extends Field

Implements the STYLEREF field. The STYLEREF is used to reference a fragment of text within the document that is formatted with the specified style.

Method Summary

Modifier and Type	Method and Description
boolean	getInsertParagraphNumber() Gets whether to insert the paragraph number of the referenced paragraph exactly as it appears in the document.
boolean	getInsertParagraphNumberInFullContext() Gets whether to insert the paragraph number of the referenced paragraph in full context.
boolean	getInsertParagraphNumberInRelativeContext() Gets whether to insert the paragraph number of the referenced paragraph in relative context.
boolean	getInsertRelativePosition() Gets whether to insert the relative position of the referenced paragraph.
boolean	getSearchFromBottom() Gets whether to search from the bottom of the current page, rather from the top.
java.lang.String	getStyleName() Gets the name of the style by which the text to search for is formatted.
boolean	getSuppressNonDelimiters() Gets whether to suppress non-delimiter characters.
int	getSwitchType(java.lang.String switchName)
void	setInsertParagraphNumber(boolean value) Sets whether to insert the paragraph number of the referenced paragraph exactly as it appears in the document.
void	setInsertParagraphNumberInFullContext(boolean value) Sets whether to insert the paragraph number of the referenced paragraph in full context.
void	setInsertParagraphNumberInRelativeContext(boolean value) Sets whether to insert the paragraph number of the referenced paragraph in relative context.
void	setInsertRelativePosition(boolean value) Sets whether to insert the relative position of the referenced paragraph.
void	setSearchFromBottom(boolean value) Sets whether to search from the bottom of the current page, rather from the top.
void	setStyleName(java.lang.String value) Sets the name of the style by which the text to search for is formatted.
void	setSuppressNonDelimiters(boolean value) Sets whether to suppress non-delimiter characters.

Methods inherited from class com.aspose.words.Field

getDisplayResult, getEnd, getFieldCode, getFieldCode, getFormat, getLocaleId, getResult, getSeparator, getStart, getType, isDirty, isDirty, isLocked, isLocked, needStoreOldResultNodes, remove, setLocaleId, setResult, unlink, update, update

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getSwitchType

public int getSwitchType(java.lang.String switchName)

getStyleName

public java.lang.String getStyleName()

Gets the name of the style by which the text to search for is formatted.

Returns:

The name of the style by which the text to search for is formatted.

setStyleName

public void setStyleName(java.lang.String value)
                  throws java.lang.Exception

Sets the name of the style by which the text to search for is formatted.

Parameters:

value - The name of the style by which the text to search for is formatted.

Throws:

java.lang.Exception

getSearchFromBottom

public boolean getSearchFromBottom()

Gets whether to search from the bottom of the current page, rather from the top.

Returns:

Whether to search from the bottom of the current page, rather from the top.

setSearchFromBottom

public void setSearchFromBottom(boolean value)
                         throws java.lang.Exception

Sets whether to search from the bottom of the current page, rather from the top.

Parameters:

value - Whether to search from the bottom of the current page, rather from the top.

Throws:

java.lang.Exception

getInsertParagraphNumber

public boolean getInsertParagraphNumber()

Gets whether to insert the paragraph number of the referenced paragraph exactly as it appears in the document.

Returns:

Whether to insert the paragraph number of the referenced paragraph exactly as it appears in the document.

setInsertParagraphNumber

public void setInsertParagraphNumber(boolean value)
                              throws java.lang.Exception

Sets whether to insert the paragraph number of the referenced paragraph exactly as it appears in the document.

Parameters:

value - Whether to insert the paragraph number of the referenced paragraph exactly as it appears in the document.

Throws:

java.lang.Exception

getInsertRelativePosition

public boolean getInsertRelativePosition()

Gets whether to insert the relative position of the referenced paragraph.

Returns:

Whether to insert the relative position of the referenced paragraph.

setInsertRelativePosition

public void setInsertRelativePosition(boolean value)
                               throws java.lang.Exception

Sets whether to insert the relative position of the referenced paragraph.

Parameters:

value - Whether to insert the relative position of the referenced paragraph.

Throws:

java.lang.Exception

getInsertParagraphNumberInRelativeContext

public boolean getInsertParagraphNumberInRelativeContext()

Gets whether to insert the paragraph number of the referenced paragraph in relative context.

Returns:

Whether to insert the paragraph number of the referenced paragraph in relative context.

setInsertParagraphNumberInRelativeContext

public void setInsertParagraphNumberInRelativeContext(boolean value)
                                               throws java.lang.Exception

Sets whether to insert the paragraph number of the referenced paragraph in relative context.

Parameters:

value - Whether to insert the paragraph number of the referenced paragraph in relative context.

Throws:

java.lang.Exception

getSuppressNonDelimiters

public boolean getSuppressNonDelimiters()

Gets whether to suppress non-delimiter characters.

Returns:

Whether to suppress non-delimiter characters.

setSuppressNonDelimiters

public void setSuppressNonDelimiters(boolean value)
                              throws java.lang.Exception

Sets whether to suppress non-delimiter characters.

Parameters:

value - Whether to suppress non-delimiter characters.

Throws:

java.lang.Exception

getInsertParagraphNumberInFullContext

public boolean getInsertParagraphNumberInFullContext()

Gets whether to insert the paragraph number of the referenced paragraph in full context.

Returns:

Whether to insert the paragraph number of the referenced paragraph in full context.

setInsertParagraphNumberInFullContext

public void setInsertParagraphNumberInFullContext(boolean value)
                                           throws java.lang.Exception

Sets whether to insert the paragraph number of the referenced paragraph in full context.

Parameters:

value - Whether to insert the paragraph number of the referenced paragraph in full context.

Throws:

java.lang.Exception