com.aspose.words

Class FieldPrint

java.lang.Object

com.aspose.words.Field

com.aspose.words.FieldPrint

public class FieldPrint
extends Field

Implements the PRINT field.

To learn more, visit the Working with Fields documentation article.

Remarks:

An instruction to send the printer-specific control code characters to the selected printer when the document is printed.

Examples:

Shows to insert a PRINT field.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 builder.write("My paragraph");

 // The PRINT field can send instructions to the printer.
 FieldPrint field = (FieldPrint) builder.insertField(FieldType.FIELD_PRINT, true);

 // Set the area for the printer to perform instructions over.
 // In this case, it will be the paragraph that contains our PRINT field.
 field.setPostScriptGroup("para");

 // When we use a printer that supports PostScript to print our document,
 // this command will turn the entire area that we specified in "field.PostScriptGroup" white.
 field.setPrinterInstructions("erasepage");

 Assert.assertEquals(" PRINT  erasepage \\p para", field.getFieldCode());

 doc.updateFields();
 doc.save(getArtifactsDir() + "Field.PRINT.docx");
 
 

Method Summary

Modifier and Type	Method and Description
java.lang.String	getPostScriptGroup() Gets the drawing rectangle that the PostScript instructions operate on.
java.lang.String	getPrinterInstructions() Gets the printer-specific control code characters or PostScript instructions.
int	getSwitchType(java.lang.String switchName)
void	setPostScriptGroup(java.lang.String value) Sets the drawing rectangle that the PostScript instructions operate on.
void	setPrinterInstructions(java.lang.String value) Sets the printer-specific control code characters or PostScript instructions.

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

getPrinterInstructions

public java.lang.String getPrinterInstructions()

Gets the printer-specific control code characters or PostScript instructions.

Examples:

Shows to insert a PRINT field.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 builder.write("My paragraph");

 // The PRINT field can send instructions to the printer.
 FieldPrint field = (FieldPrint) builder.insertField(FieldType.FIELD_PRINT, true);

 // Set the area for the printer to perform instructions over.
 // In this case, it will be the paragraph that contains our PRINT field.
 field.setPostScriptGroup("para");

 // When we use a printer that supports PostScript to print our document,
 // this command will turn the entire area that we specified in "field.PostScriptGroup" white.
 field.setPrinterInstructions("erasepage");

 Assert.assertEquals(" PRINT  erasepage \\p para", field.getFieldCode());

 doc.updateFields();
 doc.save(getArtifactsDir() + "Field.PRINT.docx");
 
 

Returns:

The printer-specific control code characters or PostScript instructions.

setPrinterInstructions

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

Sets the printer-specific control code characters or PostScript instructions.

Examples:

Shows to insert a PRINT field.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 builder.write("My paragraph");

 // The PRINT field can send instructions to the printer.
 FieldPrint field = (FieldPrint) builder.insertField(FieldType.FIELD_PRINT, true);

 // Set the area for the printer to perform instructions over.
 // In this case, it will be the paragraph that contains our PRINT field.
 field.setPostScriptGroup("para");

 // When we use a printer that supports PostScript to print our document,
 // this command will turn the entire area that we specified in "field.PostScriptGroup" white.
 field.setPrinterInstructions("erasepage");

 Assert.assertEquals(" PRINT  erasepage \\p para", field.getFieldCode());

 doc.updateFields();
 doc.save(getArtifactsDir() + "Field.PRINT.docx");
 
 

Parameters:

value - The printer-specific control code characters or PostScript instructions.

Throws:

java.lang.Exception

getPostScriptGroup

public java.lang.String getPostScriptGroup()

Gets the drawing rectangle that the PostScript instructions operate on.

Examples:

Shows to insert a PRINT field.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 builder.write("My paragraph");

 // The PRINT field can send instructions to the printer.
 FieldPrint field = (FieldPrint) builder.insertField(FieldType.FIELD_PRINT, true);

 // Set the area for the printer to perform instructions over.
 // In this case, it will be the paragraph that contains our PRINT field.
 field.setPostScriptGroup("para");

 // When we use a printer that supports PostScript to print our document,
 // this command will turn the entire area that we specified in "field.PostScriptGroup" white.
 field.setPrinterInstructions("erasepage");

 Assert.assertEquals(" PRINT  erasepage \\p para", field.getFieldCode());

 doc.updateFields();
 doc.save(getArtifactsDir() + "Field.PRINT.docx");
 
 

Returns:

The drawing rectangle that the PostScript instructions operate on.

setPostScriptGroup

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

Sets the drawing rectangle that the PostScript instructions operate on.

Examples:

Shows to insert a PRINT field.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 builder.write("My paragraph");

 // The PRINT field can send instructions to the printer.
 FieldPrint field = (FieldPrint) builder.insertField(FieldType.FIELD_PRINT, true);

 // Set the area for the printer to perform instructions over.
 // In this case, it will be the paragraph that contains our PRINT field.
 field.setPostScriptGroup("para");

 // When we use a printer that supports PostScript to print our document,
 // this command will turn the entire area that we specified in "field.PostScriptGroup" white.
 field.setPrinterInstructions("erasepage");

 Assert.assertEquals(" PRINT  erasepage \\p para", field.getFieldCode());

 doc.updateFields();
 doc.save(getArtifactsDir() + "Field.PRINT.docx");
 
 

Parameters:

value - The drawing rectangle that the PostScript instructions operate on.

Throws:

java.lang.Exception

getSwitchType

public int getSwitchType(java.lang.String switchName)