public method OutlineBuilder.SetCaption

Brief

Sets a caption with specified font settings for the TOC.

Declaration
C#
Gehtsoft.PDFFlow.Builder.OutlineBuilder  SetCaption (string outlineCaption, Gehtsoft.PDFFlow.Models.Shared.Color fontColor, System.Single fontSize = 11, string fontName = "Helvetica", bool isBold = False, bool isItalic = False, Gehtsoft.PDFFlow.Models.Enumerations.Stroke underlineStroke = None, Gehtsoft.PDFFlow.Models.Shared.Color? underlineColor = null)

Parameters
outlineCaption

The TOC caption.
fontColor

The font color for the caption.
The color can be specified using a system-defined color (for example, Color.Yellow), can be translated from an HTML color code using the method Color.FromHtml, or created from RGBA values using the method Color.FromRgba.
The RGBA red, green, blue, and alpha components must have values between 0.0f (0%, 0 byte value) and 1.0f (100%, 255 byte value). The alpha component is optional, its value is 1.0f by default, which means that the color is fully opaque.
fontSize

The font size in points for the caption.
fontName

The font name for the caption.
isBold

Defines whether the caption font style is bold. The value True indicates that the font style is bold.
isItalic

Defines whether the caption font style is italic. The value True indicates that the font style is italic.
underlineStroke

The underline stroke style for the caption font. If the value is None, the font style is not underline.
underlineColor

The underline color for the caption font.
The color can be specified using a system-defined color (for example, Color.Yellow), can be translated from an HTML color code using the method Color.FromHtml, or created from RGBA values using the method Color.FromRgba.
The RGBA red, green, blue, and alpha components must have values between 0.0f (0%, 0 byte value) and 1.0f (100%, 255 byte value). The alpha component is optional, its value is 1.0f by default, which means that the color is fully opaque.

Declared in OutlineBuilder

back