XRRichText.CanShrink Property

Gets or sets a value indicating whether the control’s height can decrease if its text does not completely fill the control.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v24.2.dll

NuGet Package: DevExpress.Reporting.Core

Declaration

C#

[Browsable(true)]
public override bool CanShrink { get; set; }

VB.NET

<Browsable(True)>
Public Overrides Property CanShrink As Boolean

Property Value

Type	Description
Boolean	true if the control’s height can decrease in order to remove the unused space; otherwise, false.

Remarks

When the CanShrink property is set to true and the control’s contents don’t completely fill the control, its height will be decreased to the height of its contents. If there are other controls below the current control, they will be moved up to avoid the unused space. Note that if a control overlaps the shrinking control by even one pixel, it will not be pushed up by the shrinking control.

Note

If the control’s XRControl.AnchorVertical property is set to VerticalAnchorStyles.Bottom or VerticalAnchorStyles.Both, the XRRichText.CanGrow and CanShrink property values are ignored, and don’t affect final height calculation for this control.

Example

The following code snippet creates the XRRichText object, specifies certain properties, and saves its contents to a file.

C#

using System;
using DevExpress.XtraReports.UI;
// ...

public XRRichText CreateXRRichText(){
    // Create a Rich Text Box control.
    XRRichText xrRichText1 = new XRRichText();

    // Set automatic height calculation,
    // and make the borders visible.
    xrRichText1.CanGrow = true;
    xrRichText1.CanShrink = true;         
    xrRichText1.Borders = DevExpress.XtraPrinting.BorderSide.All;

    // Add lines of text to the document.
    // The XRRichText control converts an array of strings into paragraphs.
    string[] boxLines = new String[3];
    boxLines[0] = "Line 1";
    boxLines[1] = "Line 2";
    boxLines[2] = "Line 3";
    xrRichText1.Lines = boxLines;

    // Export XRRichText contents to Microsoft Office Word OpenXml format (DOCX).
    xrRichText1.SaveFile("output.docx", XRRichTextStreamType.XmlText);

    return xrRichText1;
}

VB.NET

Imports System
Imports DevExpress.XtraReports.UI
' ...

Public Function CreateXRRichText() As XRRichText
    ' Create an XRRichText object.
    Dim XrRichText1 As New XRRichText()

    ' Set automatic height calculation,
    ' and make the borders visible.
    XrRichText1.CanGrow = True
    XrRichText1.CanShrink = True 
    XrRichText1.Borders = DevExpress.XtraPrinting.BorderSide.All

    ' Add lines of text to the document.
    ' The XRRichText control converts an array of strings into paragraphs.
    Dim BoxLines() As String = New String(2) {}
    BoxLines(0) = "Line 1"
    BoxLines(1) = "Line 2"
    BoxLines(2) = "Line 3"
    XrRichText1.Lines = BoxLines

    ' Export XRRichText contents to Microsoft Office Word OpenXml format (DOCX).
    XrRichText1.1SaveFile("output.txt", XRRichTextStreamType.PlainText)

    Return XrRichText1
End Function