com.aspose.words

Class FieldAsk

java.lang.Object

com.aspose.words.Field

com.aspose.words.FieldAsk

public class FieldAsk
extends Field

Implements the ASK field. Prompts the user to enter information and assigns a bookmark to represent the user's response.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBookmarkName() Gets the name of the bookmark.
java.lang.String	getDefaultResponse() Gets default user response (initial value contained in the prompt window).
boolean	getPromptOnceOnMailMerge() Gets whether the user response should be recieved once per a mail merge operation.
java.lang.String	getPromptText() Gets the prompt text (the title of the prompt window).
int	getSwitchType(java.lang.String switchName)
void	setBookmarkName(java.lang.String value) Sets the name of the bookmark.
void	setDefaultResponse(java.lang.String value) Sets default user response (initial value contained in the prompt window).
void	setPromptOnceOnMailMerge(boolean value) Sets whether the user response should be recieved once per a mail merge operation.
void	setPromptText(java.lang.String value) Sets the prompt text (the title of the prompt window).

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)

getBookmarkName

public java.lang.String getBookmarkName()

Gets the name of the bookmark.

Returns:

The name of the bookmark.

setBookmarkName

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

Sets the name of the bookmark.

Parameters:

value - The name of the bookmark.

Throws:

java.lang.Exception

getPromptText

public java.lang.String getPromptText()

Gets the prompt text (the title of the prompt window).

Returns:

The prompt text (the title of the prompt window).

setPromptText

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

Sets the prompt text (the title of the prompt window).

Parameters:

value - The prompt text (the title of the prompt window).

Throws:

java.lang.Exception

getDefaultResponse

public java.lang.String getDefaultResponse()

Gets default user response (initial value contained in the prompt window).

Returns:

Default user response (initial value contained in the prompt window).

setDefaultResponse

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

Sets default user response (initial value contained in the prompt window).

Parameters:

value - Default user response (initial value contained in the prompt window).

Throws:

java.lang.Exception

getPromptOnceOnMailMerge

public boolean getPromptOnceOnMailMerge()

Gets whether the user response should be recieved once per a mail merge operation.

Returns:

Whether the user response should be recieved once per a mail merge operation.

setPromptOnceOnMailMerge

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

Sets whether the user response should be recieved once per a mail merge operation.

Parameters:

value - Whether the user response should be recieved once per a mail merge operation.

Throws:

java.lang.Exception