LayoutViewInfoCustomizingEventArgs.ShouldRecalculateLayout Property

Forces layout recalculation after applying changes specified in the event handler.

Namespace: DevExpress.XtraScheduler

Assembly: DevExpress.XtraScheduler.v18.2.dll

Declaration

C#

public bool ShouldRecalculateLayout { get; set; }

VB.NET

Public Property ShouldRecalculateLayout As Boolean

Property Value

Type	Description
Boolean	True, to recalculate the layout to properly display modified visual elements; otherwise, false.

Remarks

Set the ShouldRecalculateLayout option to true to force layout recalculation, so that changes applied to the header in the SchedulerControl.LayoutViewInfoCustomizing event handler display correctly.

This setting is useful when certain changes, such as larger font or longer text, results in a header content that does not fit its previously calculated bounds.

Note

This setting affects only date and resource headers. Other visual elements layouts are not recalculated.

Example

This example handles the SchedulerControl.LayoutViewInfoCustomizing event to change resource header captions.

Longer text or a new line in the caption require that the header increases its height to fit the content. The ShouldRecalculateLayout option set to true forces layout recalculation so that changes applied to the header display correctly.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/winforms-schedulercontrol-api-t224044

CustomizingVisualElements.cs

    scheduler.GroupType = SchedulerGroupType.Resource;
    scheduler.ActiveViewType = SchedulerViewType.Timeline;
    scheduler.LayoutViewInfoCustomizing += scheduler_LayoutViewInfoCustomizingResourceHeaders; ;
    scheduler.ActiveView.LayoutChanged();
public static void scheduler_LayoutViewInfoCustomizingResourceHeaders(object sender, LayoutViewInfoCustomizingEventArgs e) {
    if (e.Kind == LayoutElementKind.ResourceHeader) {
        ResourceHeader header = e.ViewInfo as ResourceHeader;
        header.Caption = header.Resource.Caption + "\r\nNew long text line";
        e.ShouldRecalculateLayout = true;
    }
}

CustomizingVisualElements.vb

    scheduler.GroupType = SchedulerGroupType.Resource
    scheduler.ActiveViewType = SchedulerViewType.Timeline
    AddHandler scheduler.LayoutViewInfoCustomizing, AddressOf scheduler_LayoutViewInfoCustomizingResourceHeaders
    scheduler.ActiveView.LayoutChanged()
Public Shared Sub scheduler_LayoutViewInfoCustomizingResourceHeaders(ByVal sender As Object, ByVal e As LayoutViewInfoCustomizingEventArgs)
    If e.Kind = LayoutElementKind.ResourceHeader Then
        Dim header As ResourceHeader = TryCast(e.ViewInfo, ResourceHeader)
        header.Caption = header.Resource.Caption & ControlChars.CrLf & "New long text line"
        e.ShouldRecalculateLayout = True
    End If
End Sub

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the ShouldRecalculateLayout property.

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-schedulercontrol-api-t224044/CS/SchedulerAPISample/CodeExamples/CustomizingVisualElements.cs#L90

    header.Caption = header.Resource.Caption + "\r\nNew long text line";
    e.ShouldRecalculateLayout = true;
}

VB.NET

winforms-schedulercontrol-api-t224044/VB/SchedulerAPISample/CodeExamples/CustomizingVisualElements.vb#L102

    header.Caption = header.Resource.Caption & ControlChars.CrLf & "New long text line"
    e.ShouldRecalculateLayout = True
End If