SubDocument.SetPageBackground(Color, Boolean) Method

Sets the background color of the page and specifies whether it is shown.

Namespace: DevExpress.XtraRichEdit.API.Native

Assembly: DevExpress.RichEdit.v24.1.Core.dll

NuGet Packages: DevExpress.RichEdit.Core, DevExpress.Win.Navigation

Declaration

C#

void SetPageBackground(
    Color pageBackColor,
    bool showPageBackground
)

VB.NET

Sub SetPageBackground(
    pageBackColor As Color,
    showPageBackground As Boolean
)

Parameters

Name	Type	Description
pageBackColor	Color	A Color structure specifying the color.
showPageBackground	Boolean	true to show the specified background color; otherwise, false.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the SetPageBackground(Color, Boolean) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

winforms-spreadsheetcontrol-api-part-3/CS/SpreadsheetControl_API_Part03/CodeUtils/ExampleCodeEditor.cs#L129

{
    CurrentCodeEditor.Document.SetPageBackground((codeEvaluated) ? DXColor.Empty : DXColor.FromArgb(0xFF, 0xBC, 0xC8), true);
    CurrentCodeClassEditor.Document.SetPageBackground((codeEvaluated) ? DXColor.Empty : DXColor.FromArgb(0xFF, 0xBC, 0xC8), true);

wpf-richedit-document-api/CS/DXRichEditControlAPISample/CodeUtils/ExampleCodeEditor.cs#L131

{
    CurrentCodeEditor.Document.SetPageBackground((codeEvaluated) ? DXColor.Empty : DXColor.FromArgb(0xFF, 0xBC, 0xC8), true);
    CurrentCodeClassEditor.Document.SetPageBackground((codeEvaluated) ? DXColor.Empty : DXColor.FromArgb(0xFF, 0xBC, 0xC8), true);

winforms-richedit-document-api/CS/RichEditAPISample/CodeUtils/ExampleCodeEditor.cs#L129

{
    CurrentCodeEditor.Document.SetPageBackground((codeEvaluated) ? DXColor.Empty : DXColor.FromArgb(0xFF, 0xBC, 0xC8), true);
    CurrentCodeClassEditor.Document.SetPageBackground((codeEvaluated) ? DXColor.Empty : DXColor.FromArgb(0xFF, 0xBC, 0xC8), true);

word-document-api-examples/CS/CodeUtils/ExampleCodeEditor.cs#L129

{
    CurrentCodeEditor.Document.SetPageBackground((codeEvaluated) ? DXColor.Empty : DXColor.FromArgb(0xFF, 0xBC, 0xC8), true);
    CurrentCodeClassEditor.Document.SetPageBackground((codeEvaluated) ? DXColor.Empty : DXColor.FromArgb(0xFF, 0xBC, 0xC8), true);

spreadsheet-document-api-chart-examples/CS/SpreadsheetDocServerChartAPISamples/CodeUtils/SpreadsheetApiModuleUtils.cs#L86

void UpdatePageBackground(bool codeEvaluated) {
    CurrentCodeEditor.Document.SetPageBackground((codeEvaluated) ? DXColor.Empty : DXColor.FromArgb(0xFF, 0xBC, 0xC8), true);
}

VB.NET

winforms-spreadsheetcontrol-api-part-3/VB/SpreadsheetControl_API_Part03/CodeUtils/ExampleCodeEditor.vb#L127

Private Sub UpdatePageBackground(ByVal codeEvaluated As Boolean)
    CurrentCodeEditor.Document.SetPageBackground(If(codeEvaluated, DXColor.Empty, DXColor.FromArgb(&HFF, &HBC, &HC8)), True)
    CurrentCodeClassEditor.Document.SetPageBackground(If(codeEvaluated, DXColor.Empty, DXColor.FromArgb(&HFF, &HBC, &HC8)), True)

wpf-richedit-document-api/VB/DXRichEditControlAPISample/CodeUtils/ExampleCodeEditor.vb#L125

Private Sub UpdatePageBackground(ByVal codeEvaluated As Boolean)
    CurrentCodeEditor.Document.SetPageBackground(If(codeEvaluated, DXColor.Empty, DXColor.FromArgb(&HFF, &HBC, &HC8)), True)
    CurrentCodeClassEditor.Document.SetPageBackground(If(codeEvaluated, DXColor.Empty, DXColor.FromArgb(&HFF, &HBC, &HC8)), True)

winforms-richedit-document-api/VB/RichEditAPISample/CodeUtils/ExampleCodeEditor.vb#L127

Private Sub UpdatePageBackground(ByVal codeEvaluated As Boolean)
    CurrentCodeEditor.Document.SetPageBackground(If(codeEvaluated, DXColor.Empty, DXColor.FromArgb(&HFF, &HBC, &HC8)), True)
    CurrentCodeClassEditor.Document.SetPageBackground(If(codeEvaluated, DXColor.Empty, DXColor.FromArgb(&HFF, &HBC, &HC8)), True)

word-document-api-examples/VB/CodeUtils/ExampleCodeEditor.vb#L127

Private Sub UpdatePageBackground(ByVal codeEvaluated As Boolean)
    CurrentCodeEditor.Document.SetPageBackground(If(codeEvaluated, DXColor.Empty, DXColor.FromArgb(&HFF, &HBC, &HC8)), True)
    CurrentCodeClassEditor.Document.SetPageBackground(If(codeEvaluated, DXColor.Empty, DXColor.FromArgb(&HFF, &HBC, &HC8)), True)

spreadsheet-document-api-chart-examples/VB/SpreadsheetDocServerChartAPISamples/CodeUtils/SpreadsheetApiModuleUtils.vb#L97

Private Sub UpdatePageBackground(ByVal codeEvaluated As Boolean)
    CurrentCodeEditor.Document.SetPageBackground(If(codeEvaluated, DXColor.Empty, DXColor.FromArgb(&HFF, &HBC, &HC8)), True)
End Sub