IsDocked Property

Eplan.EplApi.DataModel.Graphics Namespace / TextBase Class / IsDocked Property

Collapse All

In This Topic

Syntax
Exceptions
See Also

EPLAN API

IsDocked Property

In This Topic

Syntax
Exceptions
See Also

Gets/Sets a value that indicates whether the text is docked or not. Setting IsDocked to true is possible only on PropertyPlacement object which Parent is a SymbolReference object.

Syntax

C#
C++/CLI

public bool IsDocked {get; set;}

public:
property bool IsDocked {
   bool get();
   void set (    bool value);
}

Exceptions

Exception	Description
Eplan.EplApi.Base.BaseException	Thrown when property cannot be set.
Eplan.EplApi.DataModel.ObjectNotCreatedException	Thrown when the PropertyPlacement object has not been initialized.
System.InvalidOperationException	Thrown when property cannot be set i.e. it is not possible to dock first PropertyPlacement.

See Also

Reference

TextBase Class
TextBase Members
DockText Method
UndockText Method

EPLAN API , 17.02.2025, © by EPLAN GmbH & Co. KG. All rights reserved.

Use the Eplan Global Support Portal for feedback and support