com.aspose.words

Class FieldFileName

java.lang.Object

com.aspose.words.Field

com.aspose.words.FieldFileName

public class FieldFileName
extends Field

Implements the FILENAME field.

Retrieves the name of the current document from its storage location.

In the current implementation, uses the Document.getOriginalFileName() property to retrieve the file name. If the document was loaded from a stream or created blank, uses the name of the file that is being saved to (if known).

Method Summary

Modifier and Type	Method and Description
boolean	getIncludeFullPath() Gets whether to include the full file path name.
int	getSwitchType(java.lang.String switchName)
void	setIncludeFullPath(boolean value) Sets whether to include the full file path name.

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

getIncludeFullPath

public boolean getIncludeFullPath()

Gets whether to include the full file path name.

Returns:

Whether to include the full file path name.

setIncludeFullPath

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

Sets whether to include the full file path name.

Parameters:

value - Whether to include the full file path name.

Throws:

java.lang.Exception

getSwitchType

public int getSwitchType(java.lang.String switchName)