GraphicalLayer Class

In This Topic

This class represents a graphical layer of the project. It can be used to modify layer's properties.

Inheritance Hierarchy

System.Object
Eplan.EplApi.DataModel.Graphics.GraphicalLayer

Syntax

C#
C++/CLI

public class GraphicalLayer

public ref class GraphicalLayer

Remarks

This class, unlike others in DataModel, saves properties like Name,Description,Visible and others after calling Store() function. It is NOT done automatic. For properly work objects of this class, they have to be associated in a GraphicalLayerTable. Some properties of Data model classes are not linked with their owners even if from the syntax it may seem otherwise. Like in this line: oRectangle.Pen.ColorId = 5, the ColorId of the Pen is changed but oRectangle object doesn't know about it since the Pen property is a stand alone value not aware of oRectangle object existence. This remark applies to the following GraphicalLayer property: Pen.

Public Constructors

	Name	Description
	GraphicalLayer Constructor	Overloaded.

Top

Public Properties

	Name	Description
	Alignment	Specifies the Justification.
	Description	Layer's description
	DrawTextBox	Returns true if the text frame exist.
	Id	Gets layer Id.
	Is3D	Specifies if layer is used for 3D graphics It is not allowed to change this property for standard layers
	IsBackGroundLayer	Specifies, if the layer is background layer
	isCustom	Returns true, if the layer is a custom layer.
	isLocked	Specifies, if the layer is locked
	isPrinted	Specifies, if the layer is printed
	IsScalable	Specifies if scale is considered with this layer
	isValid	Checks, if layer object is attached to existing project's layer.
	isVisible	Specifies visibility of the layer
	Name	Layer's name
	ParagraphSpacing	Specifies the Paragraph Spacing. This property is used for PropertyPlacemets attributes.
	Pen	Layer's pen
	RowSpacing	Specifies the Row Spacing. This property is used for PropertyPlacemets attributes. From layer: -16002, Single: 100, 1.5 lines: 150, Double: 200.
	TextHeight	Layer's text height
	TextRotation	Layer's rotation of texts
	Transparency	Specifies transparency of layer as double with a value between 0.0 and 1.0

Top

Public Methods

	Name	Description
	Create	Creates new graphical layer in graphical table. This function calls Eplan.EplApi.DataModel.Graphics.GraphicalLayerTable.AddLayer() and returned object is merged with created object.
	Dispose	Destructor for deterministic finalization of GraphicalLayer object. Destroys layer object without storing any changes into project.
	Equals	.NET operator for comparing two GraphicalLayers. Comparison is made by comparing each of GraphicalLayers members instead of internal object id.
	GetHashCode	Serves as the default hash function.
	Store	Stores modified layer's properties into project.

Top

Public Operators

Equality

.NET operator for comparing two GraphicalLayers. Comparision is made by comparing each of GraphicalLayers members instead of internal object id.

Top

Reference

GraphicalLayer Members
Eplan.EplApi.DataModel.Graphics Namespace

Send Feedback