Summary: Ctors | Methods | Inherited Methods | [Expand All]
public class

# Text2PDFOptions

extends Object

java.lang.Object
↳ | com.pdftron.pdf.Text2PDFOptions

## Summary

Public Constructors
| Text2PDFOptions() Constructor.

Public Methods
int | getBytesPerBite() Gets the value BytesPerBite from the options object
String | getFontFace() Gets the value FontFace from the options object the desired font family name
double | getFontSize() Gets the value FontSize from the options object the font size, in units of points
double | getLineHeightMultiplier() Gets the value LineHeightMultiplier from the options object The desired line height represented as some multiple of the font size
double | getMarginBottom() Gets the value MarginBottom from the options object the bottom margin in units of inches
double | getMarginLeft() Gets the value MarginLeft from the options object the left margin in units of inches
double | getMarginRight() Gets the value MarginRight from the options object the right margin in units of inches
double | getMarginTop() Gets the value MarginTop from the options object the top margin in units of inches
double | getPageHeight() Gets the value PageHeight from the options object the page height in units of inches
double | getPageWidth() Gets the value PageWidth from the options object the page width in units of inches
boolean | getUseSourceCodeFormatting() Gets the value UseSourceCodeFormatting from the options object whether to format the text as if it were source code
Text2PDFOptions | setBytesPerBite(int value) Sets the value for BytesPerBite in the options object
Text2PDFOptions | setFontFace(String value) Sets the value for FontFace in the options object the desired font family name
Text2PDFOptions | setFontSize(double value) Sets the value for FontSize in the options object the font size, in units of points
Text2PDFOptions | setLineHeightMultiplier(double value) Sets the value for LineHeightMultiplier in the options object The desired line height represented as some multiple of the font size
Text2PDFOptions | setMarginBottom(double value) Sets the value for MarginBottom in the options object the bottom margin in units of inches
Text2PDFOptions | setMarginLeft(double value) Sets the value for MarginLeft in the options object the left margin in units of inches
Text2PDFOptions | setMarginRight(double value) Sets the value for MarginRight in the options object the right margin in units of inches
Text2PDFOptions | setMarginTop(double value) Sets the value for MarginTop in the options object the top margin in units of inches
Text2PDFOptions | setPageHeight(double value) Sets the value for PageHeight in the options object the page height in units of inches
Text2PDFOptions | setPageWidth(double value) Sets the value for PageWidth in the options object the page width in units of inches
Text2PDFOptions | setUseSourceCodeFormatting(boolean value) Sets the value for UseSourceCodeFormatting in the options object whether to format the text as if it were source code

[Expand] Inherited Methods
From class java.lang.Object
boolean | equals(Object arg0)
final Class<?> | getClass()
int | hashCode()
final void | notify()
final void | notifyAll()
String | toString()
final void | wait(long arg0, int arg1)
final void | wait(long arg0)
final void | wait()

## Public Constructors

#### public Text2PDFOptions ()

Constructor.

##### Throws

PDFNetException |

## Public Methods

#### public int getBytesPerBite ()

Gets the value BytesPerBite from the options object

##### Returns

- a int, the current value for BytesPerBite.

##### Throws

PDFNetException |

#### public String getFontFace ()

Gets the value FontFace from the options object the desired font family name

##### Returns

- a String, the desired font family name.

##### Throws

PDFNetException |

#### public double getFontSize ()

Gets the value FontSize from the options object the font size, in units of points

##### Returns

- a double, the font size, in units of points.

##### Throws

PDFNetException |

#### public double getLineHeightMultiplier ()

Gets the value LineHeightMultiplier from the options object The desired line height represented as some multiple of the font size

##### Returns

- a double, The desired line height represented as some multiple of the font size.

##### Throws

PDFNetException |

#### public double getMarginBottom ()

Gets the value MarginBottom from the options object the bottom margin in units of inches

##### Returns

- a double, the bottom margin in units of inches.

##### Throws

PDFNetException |

#### public double getMarginLeft ()

Gets the value MarginLeft from the options object the left margin in units of inches

##### Returns

- a double, the left margin in units of inches.

##### Throws

PDFNetException |

#### public double getMarginRight ()

Gets the value MarginRight from the options object the right margin in units of inches

##### Returns

- a double, the right margin in units of inches.

##### Throws

PDFNetException |

#### public double getMarginTop ()

Gets the value MarginTop from the options object the top margin in units of inches

##### Returns

- a double, the top margin in units of inches.

##### Throws

PDFNetException |

#### public double getPageHeight ()

Gets the value PageHeight from the options object the page height in units of inches

##### Returns

- a double, the page height in units of inches.

##### Throws

PDFNetException |

#### public double getPageWidth ()

Gets the value PageWidth from the options object the page width in units of inches

##### Returns

- a double, the page width in units of inches.

##### Throws

PDFNetException |

#### public boolean getUseSourceCodeFormatting ()

Gets the value UseSourceCodeFormatting from the options object whether to format the text as if it were source code

##### Returns

- a boolean, whether to format the text as if it were source code.

##### Throws

PDFNetException |

#### public Text2PDFOptions setBytesPerBite (int value)

Sets the value for BytesPerBite in the options object

##### Parameters

value | a int -- the new value for BytesPerBite

##### Returns

- this object, for call chaining

##### Throws

PDFNetException |

#### public Text2PDFOptions setFontFace (String value)

Sets the value for FontFace in the options object the desired font family name

##### Parameters

value | a String -- the desired font family name

##### Returns

- this object, for call chaining

##### Throws

PDFNetException |

#### public Text2PDFOptions setFontSize (double value)

Sets the value for FontSize in the options object the font size, in units of points

##### Parameters

value | a double -- the font size, in units of points

##### Returns

- this object, for call chaining

##### Throws

PDFNetException |

#### public Text2PDFOptions setLineHeightMultiplier (double value)

Sets the value for LineHeightMultiplier in the options object The desired line height represented as some multiple of the font size

##### Parameters

value | a double -- The desired line height represented as some multiple of the font size

##### Returns

- this object, for call chaining

##### Throws

PDFNetException |

#### public Text2PDFOptions setMarginBottom (double value)

Sets the value for MarginBottom in the options object the bottom margin in units of inches

##### Parameters

value | a double -- the bottom margin in units of inches

##### Returns

- this object, for call chaining

##### Throws

PDFNetException |

#### public Text2PDFOptions setMarginLeft (double value)

Sets the value for MarginLeft in the options object the left margin in units of inches

##### Parameters

value | a double -- the left margin in units of inches

##### Returns

- this object, for call chaining

##### Throws

PDFNetException |

#### public Text2PDFOptions setMarginRight (double value)

Sets the value for MarginRight in the options object the right margin in units of inches

##### Parameters

value | a double -- the right margin in units of inches

##### Returns

- this object, for call chaining

##### Throws

PDFNetException |

#### public Text2PDFOptions setMarginTop (double value)

Sets the value for MarginTop in the options object the top margin in units of inches

##### Parameters

value | a double -- the top margin in units of inches

##### Returns

- this object, for call chaining

##### Throws

PDFNetException |

#### public Text2PDFOptions setPageHeight (double value)

Sets the value for PageHeight in the options object the page height in units of inches

##### Parameters

value | a double -- the page height in units of inches

##### Returns

- this object, for call chaining

##### Throws

PDFNetException |

#### public Text2PDFOptions setPageWidth (double value)

Sets the value for PageWidth in the options object the page width in units of inches

##### Parameters

value | a double -- the page width in units of inches

##### Returns

- this object, for call chaining

##### Throws

PDFNetException |

#### public Text2PDFOptions setUseSourceCodeFormatting (boolean value)

Sets the value for UseSourceCodeFormatting in the options object whether to format the text as if it were source code

##### Parameters

value | a boolean -- whether to format the text as if it were source code

##### Returns

- this object, for call chaining

##### Throws

PDFNetException |