TX Text Control .NET Server

ChangeZOrder Method

Method|Introduced in 18.0
Namespace
TXTextControl
Package
TXTextControl.TextControl.Core.SDK as TXTextControl.Core.dll from the private NuGet feed or Text Control Offline Packages
Also in
TXTextControl.TextControl.ASP.SDK as TXTextControl.dll

Description

Changes the frame's z-order.

Syntax

public bool ChangeZOrder(ZOrder zOrder);

Parameters

ParameterDescription
zOrder

Specifies how the z-order is changed. It can be a value of the ZOrder enumeration.

Return Value

The return value is true, if the z-order could be changed. Otherwise, it is false.

Examples

The following example adds a callout frame and works with it through the common frame API by using FrameBase.ChangeZOrder.

TextFrame callout = new(new System.Drawing.Size(3000, 1200)) { Name = "Callout" };
textControl.TextFrames.Add(callout, TextFrameInsertionMode.DisplaceText);
FrameBase frameBase = callout;

if (frameBase.ChangeZOrder(ZOrder.Up))
{
    Console.WriteLine("Change ZOrder completed successfully.");
}