Project Class

In This Topic

Class representing P8 project.

Inheritance Hierarchy

System.Object
Eplan.EplApi.DataModel.StorableObject
Eplan.EplApi.DataModel.Project

Syntax

C#
C++/CLI

public class Project : StorableObject, IArticleUser

public ref class Project : public StorableObject, IArticleUser

Remarks

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 Project properties: Articles, LayerTable, Pages.

Public Constructors

	Name	Description
	Project Constructor	Default constructor. Should never be used. Always throws NotImplementedException. It was designed only for COM compatibility.

Top

Public Properties

	Name	Description
	ArticleReferences	Returns ArticleReferences that are referenced by Project.
	Articles	Returns Articles of the Project.
	CanHaveArticleData	Check if the Project can have Articles.
	Comparisons	Returns results of comparisons of projects.
	CrossReferencedObjectsAll	Returns an array of objects cross-referenced with this object (i.e. having the same name - in case of functions - or otherwise associated) (Inherited from Eplan.EplApi.DataModel.StorableObject)
	CurrentUsers	Returns the current users working at this project.
	DatabaseIdentifier	Returns the project as number. The number is unique for all open projects in one session. The number changes when the project is closed and opened again. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	DeviceTagConfig	Predefined property for accessing following project settings: EnableSyntaxCheck, UserCharacters, AllowUserCharacters, AllowedLetters, AllowSpecialCharacters, PlantDesignationNumbersOnly.
	DocumentDirectory	Project's property which return full project documents' directory name
	Filter	Enables access to pages filter.
	FunctionDefinitionLibrary	Returns standard Eplan.EplApi.DataModel.MasterData.FunctionDefinitionLibrary of project.
	ImageDirectory	Project's property which return full project images' directory name.
	InstallationSpaces	Returns array of all Eplan.EplApi.DataModel.E3D.InstallationSpace from this Project.
	IsExclusive	Project's property which gives information if the project is opened exclusive
	IsLocked	Overridden. Determines if the the StorableObject is locked. The StorableObject is locked when it was explicitly or implicitly locked.
	IsOpen	Project's property which gives information if the project is opened or is not.
	IsReadOnly	Overridden. Determines if StorableObject is read-only
	IsTransient	Determines if the the StorableObject is transient. The StorableObject is transient when it was created by default constructor and: it is a Page and it was not assigned a Project, it is a Placement or any class derived from it and was not assigned a Page. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	IsValid	Determines if StorableObject is correct database object and is not deleted. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	LayerTable	Returns layer table of the project.
	ObjectIdentifier	Returns the object identifier as number. The number is unique for all objects of this type. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	OptionGroups	Returns array of OptionGroups assigned to the `Project`.
	Options	Returns array of Options assigned to the `Project` but not those that are assigned to OptionGroups.
	Pages	Project's property which return array of Pages placed in project. When the project's PagesFilter was set-up, pages matching the filter are returned.
	PlanningSegments	Returns array of all Eplan.EplApi.DataModel.Planning.PlanningSegment from this Project.
	Project	Returns the project the StorableObject belongs to. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	ProjectDirectoryPath	Project's property which return full project's directory name.
	ProjectFullName	Project's property which return full project name, without an extension.
	ProjectLinkFilePath	Project's property which return full project-link file name.
	ProjectName	Project's property which return Name of Project - project name only without path.
	Properties	Enables access to P8 properties of the project.
	PropertyPlacementsSchemaId	Gets currently used schema Id, that was choosen in GUI in ribbon Tools / Property Arrangements ribbon.
	Sections	Returns an object used to manage project sections.
	SegmentDefinitions	Returns array of all Eplan.EplApi.DataModel.Planning.SegmentDefinition from this Project.
	SegmentTemplates	Returns array of all Eplan.EplApi.DataModel.Planning.SegmentTemplate from this Project.
	Settings	Project settings
	SymbolLibraries	Gets the symbol libraries used by the project.
	TypeIdentifier	Returns the type of the object as number. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	TypeOfProject	Type of project To change this property project will be reopened temporarily in exclusive mode. If project cannot be reopened in exclusive mode BaseException will be thrown.
	UserDefinedPropertyDefinitions	Returns array of all UserDefinedPropertyDefinition from this project.

Top

Public Methods

	Name	Description
	AddArticleReference	Overloaded. Adds a new ArticleReference to the Project. Returns the added ArticleReference.
	AddOption	Overloaded. Adds Option to the `Project`.
	AddOptionGroup	Overloaded. Adds OptionGroup to the `Project`. The description is set to an empty multilang value.
	ChangeLocationName	Changes name of the given location. After that change a location object becomes invalid, to get this object once again, use the GetLocationObjects function.
	Close	Closes the project. Must not be called before Remove()
	CreateLocation	Overloaded. Creates location in the given hierarchy, and places it in position eRelPos relatively to the existing location strExistingLocation.
	Dispose()	Destructor for deterministic finalization of Project object. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	Equals	Operator of comparison implementation. Checks if two StorableObjects refer to the same object in the project. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	GetHashCode	Serves as the default hash function. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	GetLocationObjects	Overloaded. Returns array of all project's location objects.
	GetLocationPrototype	Creates location prototype using property list pProps. Property identifiers that describe location are written to the list.
	GetLocations	Returns array of names of project's location for given hierarchy type (PLANT, LOCATION etc.)
	GetNamePrototype	Overloaded. Gets the name prototype for a given function group. For given function group two separate lists with properties used in project structure are created.
	GetOptionByName	Method for finding Option assigned to the `Project` with a given name.
	GetOptionGroupByName	Method for finding OptionGroup assigned to the `Project` with a given name.
	GetSegmentDefinition	Returns Eplan.EplApi.DataModel.Planning.SegmentDefinition from this Project with given name.
	GetTypeName	Returns object type name. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	LockAllObjects	Locks all data model objects in the project.
	LockObject	Tries to lock current object in database for exclusive access. Throws Eplan.EplApi.Base.LockingException on failure. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	ParseNameAndProps	Parsing of function name with additional properties.
	Remove	Removes the project. Must not be called after Close()
	RemoveAllPages	Removes all pages from project.
	RemoveArticleReference	Removes the ArticleReference from the Project
	SetSortedLocations	Sets the location order, as in the arrLocations parameter, for given hierarchy type. Locations existing in project and not passed in arrLocations are placed after the passed ones. If arrLocations parameter contains not existing location name, this method returns false and no changes are made to the project
	SmartLock	Tries to lock current object. If object is Placement - it's page will be locked as well; Eplan.EplApi.DataModel.E3D.Placement3D locks it's installation space; Function locks all it's connections and connection definition points; Page locks all placements from this page. Throws Eplan.EplApi.Base.LockingException on failure. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	ToString	Returns a string that represents the current object.
	ToStringIdentifier	Returns this object as string identifier. (Inherited from Eplan.EplApi.DataModel.StorableObject)

Top

Reference

Project Members
Eplan.EplApi.DataModel Namespace

Send Feedback