Class PrintCompositor
- Namespace
- GtkSource
- Assembly
- GtkSource-5.dll
public class PrintCompositor : Object, IDisposable, NativeObject, GTypeProvider, InstanceFactory
- Inheritance
-
PrintCompositor
- Implements
- Inherited Members
Constructors
PrintCompositor(params ConstructArgument[])
[Obsolete("Regular C# constructors on native classes will be removed in a future version. Please see the linked documentation for more details. It contains scenarios and possible solutions to prepare for the upcoming changes.", DiagnosticId = "GirCore1007", UrlFormat = "https://gircore.github.io/docs/integration/diagnostic/1007.html")]
public PrintCompositor(params ConstructArgument[] constructArguments)
Parameters
constructArgumentsConstructArgument[]
PrintCompositor(CreationData)
[Obsolete("This constructor is a workaround to keep legacy APIs alive. Do not use it.")]
protected PrintCompositor(CreationData data)
Parameters
dataCreationData
PrintCompositor(PrintCompositorHandle)
protected PrintCompositor(PrintCompositorHandle handle)
Parameters
handlePrintCompositorHandle
Fields
BodyFontNamePropertyDefinition
public static readonly Property<string?, PrintCompositor> BodyFontNamePropertyDefinition
Field Value
BufferPropertyDefinition
public static readonly Property<Buffer?, PrintCompositor> BufferPropertyDefinition
Field Value
FooterFontNamePropertyDefinition
public static readonly Property<string?, PrintCompositor> FooterFontNamePropertyDefinition
Field Value
HeaderFontNamePropertyDefinition
public static readonly Property<string?, PrintCompositor> HeaderFontNamePropertyDefinition
Field Value
HighlightSyntaxPropertyDefinition
public static readonly Property<bool, PrintCompositor> HighlightSyntaxPropertyDefinition
Field Value
LineNumbersFontNamePropertyDefinition
public static readonly Property<string?, PrintCompositor> LineNumbersFontNamePropertyDefinition
Field Value
NPagesPropertyDefinition
public static readonly Property<int, PrintCompositor> NPagesPropertyDefinition
Field Value
PrintFooterPropertyDefinition
public static readonly Property<bool, PrintCompositor> PrintFooterPropertyDefinition
Field Value
PrintHeaderPropertyDefinition
public static readonly Property<bool, PrintCompositor> PrintHeaderPropertyDefinition
Field Value
PrintLineNumbersPropertyDefinition
public static readonly Property<uint, PrintCompositor> PrintLineNumbersPropertyDefinition
Field Value
TabWidthPropertyDefinition
public static readonly Property<uint, PrintCompositor> TabWidthPropertyDefinition
Field Value
WrapModePropertyDefinition
public static readonly Property<WrapMode, PrintCompositor> WrapModePropertyDefinition
Field Value
Properties
BodyFontName
public string? BodyFontName { get; set; }
Property Value
Buffer
public Buffer? Buffer { get; }
Property Value
FooterFontName
public string? FooterFontName { get; set; }
Property Value
HeaderFontName
public string? HeaderFontName { get; set; }
Property Value
HighlightSyntax
public bool HighlightSyntax { get; set; }
Property Value
LineNumbersFontName
public string? LineNumbersFontName { get; set; }
Property Value
NPages
public int NPages { get; }
Property Value
PrintFooter
public bool PrintFooter { get; set; }
Property Value
PrintHeader
public bool PrintHeader { get; set; }
Property Value
PrintLineNumbers
public uint PrintLineNumbers { get; set; }
Property Value
TabWidth
public uint TabWidth { get; set; }
Property Value
WrapMode
public WrapMode WrapMode { get; set; }
Property Value
Methods
DrawPage(PrintContext, int)
public void DrawPage(PrintContext context, int pageNr)
Parameters
contextPrintContextpageNrint
GetBodyFontName()
public string GetBodyFontName()
Returns
GetBottomMargin(Unit)
public double GetBottomMargin(Unit unit)
Parameters
unitUnit
Returns
GetBuffer()
public Buffer GetBuffer()
Returns
GetFooterFontName()
public string GetFooterFontName()
Returns
GetGType()
public static Type GetGType()
Returns
GetHeaderFontName()
public string GetHeaderFontName()
Returns
GetHighlightSyntax()
public bool GetHighlightSyntax()
Returns
GetLeftMargin(Unit)
public double GetLeftMargin(Unit unit)
Parameters
unitUnit
Returns
GetLineNumbersFontName()
public string GetLineNumbersFontName()
Returns
GetNPages()
public int GetNPages()
Returns
GetPaginationProgress()
public double GetPaginationProgress()
Returns
GetPrintFooter()
public bool GetPrintFooter()
Returns
GetPrintHeader()
public bool GetPrintHeader()
Returns
GetPrintLineNumbers()
public uint GetPrintLineNumbers()
Returns
GetRightMargin(Unit)
public double GetRightMargin(Unit unit)
Parameters
unitUnit
Returns
GetTabWidth()
public uint GetTabWidth()
Returns
GetTopMargin(Unit)
public double GetTopMargin(Unit unit)
Parameters
unitUnit
Returns
GetWrapMode()
public WrapMode GetWrapMode()
Returns
IgnoreTag(TextTag)
[Version("5.2")]
public void IgnoreTag(TextTag tag)
Parameters
tagTextTag
New(Buffer)
public static PrintCompositor New(Buffer buffer)
Parameters
bufferBuffer
Returns
NewFromPointer(nint, bool)
Creates a new managed PrintCompositor instance for a given pointer.
public static PrintCompositor NewFromPointer(nint ptr, bool ownsHandle)
Parameters
Returns
NewFromView(View)
public static PrintCompositor NewFromView(View view)
Parameters
viewView
Returns
NewWithProperties(ConstructArgument[])
Creates a new PrintCompositor and sets the properties specified by the construct arguments.
public static PrintCompositor NewWithProperties(ConstructArgument[] constructArguments)
Parameters
constructArgumentsConstructArgument[]The properties to set.
Returns
Paginate(PrintContext)
public bool Paginate(PrintContext context)
Parameters
contextPrintContext
Returns
SetBodyFontName(string)
public void SetBodyFontName(string fontName)
Parameters
fontNamestring
SetBottomMargin(double, Unit)
public void SetBottomMargin(double margin, Unit unit)
Parameters
SetFooterFontName(string?)
public void SetFooterFontName(string? fontName)
Parameters
fontNamestring
SetFooterFormat(bool, string?, string?, string?)
public void SetFooterFormat(bool separator, string? left, string? center, string? right)
Parameters
SetHeaderFontName(string?)
public void SetHeaderFontName(string? fontName)
Parameters
fontNamestring
SetHeaderFormat(bool, string?, string?, string?)
public void SetHeaderFormat(bool separator, string? left, string? center, string? right)
Parameters
SetHighlightSyntax(bool)
public void SetHighlightSyntax(bool highlight)
Parameters
highlightbool
SetLeftMargin(double, Unit)
public void SetLeftMargin(double margin, Unit unit)
Parameters
SetLineNumbersFontName(string?)
public void SetLineNumbersFontName(string? fontName)
Parameters
fontNamestring
SetPrintFooter(bool)
public void SetPrintFooter(bool print)
Parameters
printbool
SetPrintHeader(bool)
public void SetPrintHeader(bool print)
Parameters
printbool
SetPrintLineNumbers(uint)
public void SetPrintLineNumbers(uint interval)
Parameters
intervaluint
SetRightMargin(double, Unit)
public void SetRightMargin(double margin, Unit unit)
Parameters
SetTabWidth(uint)
public void SetTabWidth(uint width)
Parameters
widthuint
SetTopMargin(double, Unit)
public void SetTopMargin(double margin, Unit unit)
Parameters
SetWrapMode(WrapMode)
public void SetWrapMode(WrapMode wrapMode)
Parameters
wrapModeWrapMode