Ofcas.Lk.Api.Client - Version 3.0 3.0.0.112

Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
[detail level 1 2 3 4 5 6 7]

▼N Ofcas |
▼N Lk |
▼N Api |
▼N Client |
▼N Core |
▼N Exceptions |
C ApiException | An internal exception.
C ServiceNotFoundException | Occurs if the host was not found.
▼N Interfaces |
C ICoreInfo | This is the base interface for object-related information.
C ICoreInfoDeletable | Basic interface for erasable objects, e.g. for an elevation (ElevationInfo).
C ICoreInfoReportable | Basic class for reportable objects, e.g. for an elevation (ElevationInfo).
C ICoreInfoWithGuid | Represents a ICoreInfo with a globally unique identifier.
C ICoreInfoWithParent | This interface is deprecated. Please use ICoreInfo<TParent>.ParentInfo instead, to identify the hierarchy.
C ICoreObject | Represents a basic core object which lifetime is controlled by the creator.
C ICoreObjectFactory | A factory to create a new structure of ICoreObject based on the stated ICoreInfo.
C ICoreObjectWithChildren | Represents a ICoreObject with children.
C ICoreObjectWithDocuments | Represents a ICoreObject with documents.
C ICoreObjectWithInfo | Represents a ICoreObject with an own info object.
C ICoreObjectWithParameters | Represents a ICoreObject with parameters.
C ICoreObjectWithParent | Represents a ICoreObject with a parent.
C ICoreObjectWithSynchronizations | Represents a ICoreObject with a ISynchronizationContainer.
C ISynchronizationContainer | Used to retrieve ISynchronizedEvent and ISynchronizationContainer.
C CoreInfo |
C CoreObjectBase | CoreObjectBase is the base class for all objects and holds general data (for example, the object instance ID of the parent). Each object is assigned with a unique identification number (Id)
C CoreObjectFullyQualified | Realisation of ICoreObjectWithChildren<TChild,TChildInfo>, ICoreObjectWithParent<TParent>, ICoreObjectWithInfo<TOwnInfo>.
C CoreObjectWithChildren | Realisation of ICoreObjectWithChildren<TChild,TChildInfo>.
C Disposable | Disposable pattern helper class.
C Document | The class Document is the represenation of a LogiKal document.
C DocumentContainer | DocumentContainer gives access to manage documents. Documents can be used in projects (Project).
C DocumentInfo | Represents the metadata to a Document
C ElementPricelist | The element pricelist is a representation of a xml-based elevation configuration.
C ElementPricelistContainer | The container of the element pricelists.
C ElementPricelistElevationInfo | Represents the metadata to an element pricelist-based Elevation.
C ElementPricelistInfo | Represent the metadata of an ElementPricelist.
C ElementType | ElementType represents an available element construction types. Available types can be received with the method LoginScope.GetElementTypes.
C Elevation | Elevation is the representation of a LogiKal element (for example, a window, a facade, ...). The children are of type ElevationInstance. The children can be received from the InfoList (CoreObject<T>.Infos).
C ElevationEditMode | ElevationEditMode represents an available edit mode for elevations. Available modes can be received with the method Elevation.GetEditModes.
C ElevationInfo | Represents the metadata to a Elevation
C ElevationInstance | ElevationInstance is the representation of an instance for an element (Elevation). An instance of an elavation has no children.
C ElevationInstanceInfo | Represents the metadata to a ElevationInstance.
C GdzSettings | This class is deprecated.
C GraphicSettings | This class is deprecated.
C LoginScope | The LoginScope is the the scope to interact with LogiKal. The LoginScope can only be received by valid connection to a service (LoginScopeFactoryBase<T>.Login). It is necessary that a service is running. Currently only memory binding is supported. The children are of type ProjectCenter. The children can be received from the CoreObject<T>.Infos.
C MaterialElevationInfo | Represents the metadata to a material Elevation.
C OperationInfo | Contains information about an operation whether it can be called.
C Phase | Phase is the representation of a LogiKal phase. The children are of type Elevation. The children can be received from the InfoList (CoreObject<T>.Infos).
C PhaseInfo | Represents a metadata object for a phase.
C Project | Project is the representation of a LogiKal project. The children are of type Phase. The children can be received from the InfoList (CoreObjectWithChildren<Phase, PhaseInfo>.ChildrenInfos).
C ProjectCenter | ProjectCenter is the representation of a LogiKal project-center. The children are of type Project. The children can be received from the InfoList (CoreObjectWithChildren<TChild,TChildInfo>.ChildrenInfos). Each ProjectCenter belongs to a fixed directory. To use another project directory, create a new project center using method GetProjectCenter.
C ProjectCenterInfo | Represents the metadata to a ProjectCenter
C ProjectDirectoryInfo | Represents the directory data to a ProjectCenter
C ProjectInfo | Represents the metadata to a Project
C ProjectInformation | ProjectInformation is the representation of an item from a project information (for example the project information items for 'Special Lengths').
C ProjectInformationContainer | The ProjectInformationContainer is used to manage ProjectInformations belonging to a Project
C ProjectInformationInfo | Represents the metadata belonging to an ProjectInformation.
C ReportCategory | ReportCategory represents a report category. The report items (ReportItem) are sorted in these categrories. Available reports can be received with the method Project.GetReports.
C ReportItem | ReportItem represents an available report. Available reports can be received with the method Project.GetReports.
C Settings3D | This class is deprecated.
C TextElevationInfo | Represents the metadata to a textbased Elevation.
▼N Ui |
▼N Interfaces |
C IDialogResult | Specifies the result of a dialog with a result code.
C DialogResult |
C ElevationUi | ElevationUi is the representation of a LogiKal element (for example, a window, a facade, ...) and provides methods with user interaction. The children are of type ElevationInstance. The children can be received from the InfoList (CoreObject<T>.Infos).
C LoginScopeUi | The LoginScopeUi is the the scope to interact with LogiKal via user interfaces. The LoginScopeUi can only be obtained by using the ServiceProxyBase. It is necessary that a service is running. Currently only memory binding is supported. The children are of type ProjectCenterUi. The children can be received from the CoreObject<T>.Infos.
C PhaseUi | PhaseUi is the representation of a LogiKal phase and provides methods with user interactions. The children are of type ElevationUi. The children can be received from the InfoList (CoreObject<T>.Infos).
C ProjectCenterUi | ProjectCenterUi is the representation of a LogiKal project-center. The ProjectCenterUi provides methods with user interactions. The children are of type Project. The children can be received from the InfoList (CoreObjectWithChildren<TChild,TChildInfo>.ChildrenInfos). Each ProjectCenter project center belongs to a fixed directory. To use another project directory, create a new project center using method ProjectCenter.GetProjectCenter.
C ProjectInformationContainerUi | ProjectInformationContainerUi contains methods to manage ProjectInformations. Specifically, ProjectInformationContainerUi provides methods that require a user interaction.
C ProjectInformationUi | ProjectInformationUi is the representation of an item from a project information (for example the project information items for 'Special Lengths') and provides methods with user interactions.
C ProjectUi | ProjectUi is the representation of a LogiKal project and provides methods with user interactions. The children are of type PhaseUi. The children can be received from the InfoList (CoreObject<T>.Infos).
C ServiceProxy | ServiceProxy is used to establish a connection to the service. The ServiceProxy ensures that the necessary service is started (Start). The service to be used is part of the LogiKal installation. After the start of the service the login takes place (Login). If a scope is completed, the service must be terminate with the method Stop. The ServiceProxy must be held during the lifetime of the scope.
C ServiceProxyBase |
▼N Shared |
▼N DC |
▼N Interfaces |
C IElevationProcessingStatus | The process status for an elevation.
C IProjectInformationType | The process status for an elevation.
C ISynchronization |
C ISynchronizationException |
C ITranslatedEnum |
C ElevationSource |
C ExportResult |
C LastErrorInfo |
C LoginRunnableProgram | Represents a login-specific runnable program.
C ProgramInformation |
C ProgramRuntimeInformation |
C ProjectAddress | Represents an address attached to a project
C ProjectRunnableProgram | Represents a project-specific runnable program.
C ProjectSource |
C ReportResult |
C Restriction |
C RunnableProgram | Represents a runnable program.
C SurfaceData |
C SynchronizationRestriction |
C WellKnownSettingKeys | Well known keys for the settings.