API Help
Eplan.EplApi.DataModel Namespace / Project Class
Properties Methods

In This Topic
    Project Class Members
    In This Topic

    The following tables list the members exposed by Project.

    Public Constructors
     NameDescription
    Public ConstructorDefault constructor. Should never be used. Always throws NotImplementedException. It was designed only for COM compatibility.  
    Top
    Public Properties
     NameDescription
    Public PropertyReturns ArticleReferences that are referenced by Project.  
    Public PropertyReturns Articles of the Project.  
    Public PropertyCheck if the Project can have Articles.  
    Public PropertyReturns results of comparisons of projects.  
    Public PropertyReturns 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)
    Public PropertyReturns the current users working at this project.  
    Public PropertyReturns 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)
    Public PropertyPredefined property for accessing following project settings: EnableSyntaxCheck, UserCharacters, AllowUserCharacters, AllowedLetters, AllowSpecialCharacters, PlantDesignationNumbersOnly.  
    Public PropertyProject's property which return full project documents' directory name  
    Public PropertyEnables access to pages filter.  
    Public PropertyReturns standard Eplan.EplApi.DataModel.MasterData.FunctionDefinitionLibrary of project.  
    Public PropertyProject's property which return full project images' directory name.  
    Public PropertyReturns array of all Eplan.EplApi.DataModel.E3D.InstallationSpace from this Project.  
    Public PropertyProject's property which gives information if the project is opened exclusive  
    Public PropertyOverridden. 

    Determines if the the StorableObject is locked.

    The StorableObject is locked when it was explicitly or implicitly locked.

     
    Public PropertyProject's property which gives information if the project is opened or is not.  
    Public PropertyOverridden. Determines if StorableObject is read-only  
    Public Property

    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)
    Public PropertyDetermines if StorableObject is correct database object and is not deleted. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyReturns layer table of the project.  
    Public PropertyReturns the object identifier as number. The number is unique for all objects of this type. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyReturns array of OptionGroups assigned to the Project.  
    Public PropertyReturns array of Options assigned to the Project but not those that are assigned to OptionGroups.  
    Public PropertyProject's property which return array of Pages placed in project. When the project's PagesFilter was set-up, pages matching the filter are returned.  
    Public PropertyReturns array of all Eplan.EplApi.DataModel.Planning.PlanningSegment from this Project.  
    Public PropertyReturns the project the StorableObject belongs to. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyProject's property which return full project's directory name.  
    Public PropertyProject's property which return full project name, without an extension.  
    Public PropertyProject's property which return full project-link file name.  
    Public PropertyProject's property which return Name of Project - project name only without path.  
    Public PropertyEnables access to P8 properties of the project.  
    Public PropertyReturns an object used to manage project sections.  
    Public PropertyReturns array of all Eplan.EplApi.DataModel.Planning.SegmentDefinition from this Project.  
    Public PropertyReturns array of all Eplan.EplApi.DataModel.Planning.SegmentTemplate from this Project.  
    Public PropertyProject settings  
    Public PropertyGets the symbol libraries used by the project.  
    Public PropertyReturns the type of the object as number. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyType 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.  
    Public PropertyReturns array of all UserDefinedPropertyDefinition from this project.  
    Top
    Public Methods
     NameDescription
    Public MethodOverloaded. Adds a new ArticleReference to the Project. Returns the added ArticleReference.  
    Public MethodOverloaded. Adds Option to the Project.  
    Public MethodOverloaded. Adds OptionGroup to the Project. The description is set to an empty multilang value.  
    Public MethodCloses the project. Must not be called before Remove()  
    Public MethodOverloaded. Creates location in the given hierarchy, and places it in position eRelPos relatively to the existing location strExistingLocation.  
    Public MethodDestructor for deterministic finalization of Project object. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodOperator of comparison implementation. Checks if two StorableObjects refer to the same object in the project. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodServes as the default hash function. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodOverloaded. Returns array of all project's location objects.  
    Public MethodCreates location prototype using property list pProps. Property identifiers that describe location are written to the list.  
    Public MethodReturns array of names of project's location for given hierarchy type (PLANT, LOCATION etc.)  
    Public MethodOverloaded. Gets the name prototype for a given function group. For given function group two separate lists with properties used in project structure are created.  
    Public MethodMethod for finding Option assigned to the Project with a given name.  
    Public MethodMethod for finding OptionGroup assigned to the Project with a given name.  
    Public MethodReturns Eplan.EplApi.DataModel.Planning.SegmentDefinition from this Project with given name.  
    Public MethodLocks all data model objects in the project.  
    Public MethodTries to lock current object in database for exclusive access. Throws Eplan.EplApi.Base.LockingException on failure. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodParsing of function name with additional properties.  
    Public MethodRemoves the project. Must not be called after Close()  
    Public MethodRemoves all pages from project.  
    Public MethodRemoves the ArticleReference from the Project  
    Public MethodSets 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  
    Public MethodTries 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)
    Public MethodReturns a string that represents the current object.  
    Public MethodReturns this object as string identifier. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Top
    See Also