Click or drag to resize
ABB.Robotics.RobotStudio Namespace
Classes
  ClassDescription
Public classAttributeCollection
Represents a collection of Attributes attached to a ProjectObject. Attributes are stored as a key/value pair. Keys can be assoicated with a Guid. A key with a Guid can only be removed by a client that knows the Guid.
Public classAutoSaveAvailableEventArgs
Provides data for the AutoSaveAvailable event
Public classCollectionChangedEventArgs
Provides data for the Changed event on various collections.
Public classCompressorInfo
Contains information about a specific compressor (codec)
Public classCustomProjectObject
Base class for custom ProjectObject derived classes.
Public classDataRecorderBase
A data recorder collects data from all its souces, and distributes it to its sinks.
Public classDataRecorderDataAddedEventArgs
Public classDataRecorderSignal
Represents a piece of information that can be recorder by a DataRecorder
Public classDataRecorderSignalCollection
Represents a collection of DataRecorderSignal objects.
Public classDataRecorderSinkAddedEventArgs
Provides data for the DataRecorderSinkAdded event of the collection.
Public classDataRecorderSinkBase
Base class for a data recorder sink, which will get notified when signals subscribed by the data recorder is updated.
Public classDataRecorderSinkBase2
Base class for a data recorder sink, which will get notified when signals subscribed by the data recorder is updated.
Public classDataRecorderSinkCollection
Represents a collection of DataRecorderSinkBase objects.
Public classDataRecorderSinkRemovedEventArgs
Provides data for the DataRecorderSinkRemoved event of the collection.
Public classDataRecorderSourceAddedEventArgs
Provides data for the DataRecorderSourceAdded event of the collection.
Public classDataRecorderSourceBase
A data recorder source provides information to a data recorder.
Public classDataRecorderSourceBaseAsync
A DataRecorderSourceBase that supports asynchronous operations for subscribing and unsubscribing signals.
Public classDataRecorderSourceCollection
Represents a collection of DataRecorderSourceBase objects.
Public classDataRecorderSourceRemovedEventArgs
Provides data for the DataRecorderSourceRemoved event of the collection.
Public classDataRecorderSubscribeSignalResult
Provides information about the
Public classDataRecorderTickEventArgs
Provides data for the Tick event.
Public classDocumentHistoryEntry
Additional document properties for a specific point in time.
Public classDocumentInfo
This class gives access to document properties such as title, comments, preview etc.
Public classExceptionEventArgs
Provides data for events such as DocumentProvider.Error.
Public classExceptionLogMessage
A log message representing an Exception.
Public classHostedAddInBase
Base class for a PowerPac type add-in.
Public classLicenseValidator
Manages licenses that unlock licensed features
Public classLoadContext
Identifies the context (document) of a loaded CustomProjectObject
Public classCode exampleLogger
Provides methods and events to support logging of messages to the user.
Public classCode exampleLogMessage
Represents a log message that can be added to the Logger.
Public classLogMessageActivatedEventArgs
Provides data for the LogMessageActivated event of the Logger.
Public classLogMessageAddedEventArgs
Provides data for the LogMessageAdded event of the Logger.
Public classLogMessageRemovedEventArgs
Provides data for the LogMessageRemoved event of the Logger.
Public classMeasuringUnit
Represents a measuring unit such as meter, millimeter, m/s, rad/s2. A unit belongs to a quantity. For example meter and millimeter belongs to the quantity length, and m/s belongs to the quantity velocity.
Public classMeasuringUnitCollection
Represents a collection of measuring units.
Public classOptions
Provides static methods, properties and events to store and read user options. Options are grouped in sections.
Public classProject
Base class for all project types. Available project types will differ depending on the product that this API is used within.
Public classProjectDocument
Represents a document associated with a project.
Public classProjectDocumentCollection
Represents a collection of ProjectDocuments.
Public classProjectFileEventArgs
Provides data for the BeforeLoadProjectFile event.
Public classProjectFileLockedEventArgs
Provides data for the ProjectFileLocked event
Public classProjectObject
Abstract base class for all objects that can be part of a Project. It can not be instantiated.
Public classProjectObjectChangedEventArgs
Provides data for the ProjectObjectChanged event.
Public classProjectObjectCollection
Represents a collection of ProjectObjects
Public classProjectObjectPropertyChangedEventArgs
Provides data for events of type ProjectObjectPropertyChangedEventHandler.
Public classProjectObjectRemovedEventArgs
Provides data for the ProjectObjectRemoved event of the Project.
Public classProjectSelection
Represents a collection of all selected objects. Selection is a concept used from the user interface. Typically it is used to specify for which objects to perform an action, to view information for specific objects and to show which operations that are availble for specific objects. The most common way for a user to select an object is to click with the mouse in the graphic view or in a browser. Using this object you can programatically control which objects that are selected and get notified when selection has changed.
Public classProjectVersionEventArgs
Provides data for the ProjectFileDifferentVersion event.
Public classQuantity
Represents a SI quantity such as length, time, area etc.
Public classReferencedProjectFileNotFoundEventArgs
Provides data for the ReferencedProjectFileNotFound event
Public classReferencedProjectFileNotSameEventArgs
Provides data for the ReferencedProjectFileNotSame event
Public classRobotStudioAPI
Intended for internal use only.
Public classRobotStudioLicenseException
This exception is thrown by certain API methods when the license check fails.
Public classSavedState
Represents a set of object states (such as property or signal values) for one or more ProjectObjects.
Public classSavedStateCollection
Represents a collection of SavedState objects.
Public classSavingProjectEventArgs
Provides data for the Saving event
Public classScreenRecorder
Represents a recording device that can record frames from the screen.
Public classSectionChangedEventArgs
Provides data for the Options.SectionChanged event
Public classSelection
Provides access to a collection containing all selected objects.
Public classSelectionEventArgs
Provides data for the ProjectSelection.ObjectAdded and ProjectSelection.ObjectRemoved events.
Public classSolution
A solution represents a folder structure with associated projects and documents
Public classToolControlServices
Provides methods for showing a Control in the a singleton tool window.
Public classUndoContext
Gives access to a state based undo mechanism for ProjectObjects. Each Project has its own undo context. The undo context makes it possible to group changes to ProjectObjects. All changes in the group can then be undone and redone.
Structures
  StructureDescription
Public structureDataRecorderSignalInfo
Represents information such as data type and quantity of a DataRecorderSignal
Public structureLicenseInformation
Contains information about a license
Interfaces
  InterfaceDescription
Public interfaceIChange
Interface for objects that represent an undoable operation.
Public interfaceICustomContextType
Enables context based UI based on instance data rather than object type.
Public interfaceIHasSystemId
Interface for objects that provide a SystemId property.
Public interfaceIProgressCallback
Callback interface for time-consuming operations.
Public interfaceISupportCopy
This interface is implemented by project objects which are possible to copy. It is typically used when implementing Copy/Paste functionality.
Delegates
  DelegateDescription
Public delegateAutoSaveAvailableEventHandler
Represents the method that will handle the AutoSaveAvailable event of the Project.
Public delegateCollectionChangedEventHandler
Represents the method that will handle the Changed event for various collections.
Public delegateLogMessageActivatedEventHandler
Represents a method that will handle activated log messages.
Public delegateLogMessageAddedEventHandler
Represents the method that will handle the LogMessageAdded event of the Logger class.
Public delegateLogMessageRemovedEventHandler
Represents the method that will handle the LogMessageRemoved event of the Logger class.
Public delegateProgressNotification
Represents the method that will handle progress notification callbacks. Some time consuming methods provides a progress notification callback, and accepts this delegate as an argument.
Public delegateProjectFileEventHandler
Represents the method that will handle the BeforeLoadProjectFile event.
Public delegateProjectFileLockedEventHandler
Represents the method that will handle the ProjectFileLocked event of the Project.
Public delegateProjectObjectChangedEventHandler
Represents the method that will handle the ProjectObjectChangedevent of a ProjectObject.
Public delegateProjectObjectPropertyChangedEventHandler
Represents the method that will handle the ProjectObjectPropertyChangedEventArgs event.
Public delegateProjectObjectRemovedEventHandler
Represents the method that will handle the ProjectObjectRemoved event of the Project.
Public delegateReferencedProjectFileNotFoundEventHandler
Represents the method that will handle the ReferencedProjectFileNotFound event of the Project.
Public delegateReferencedProjectFileNotSameEventHandler
Represents the method that will handle the ReferencedProjectFileNotSame event of the Project.
Public delegateSavingProjectEventHandler
Represents the method that will handle the Saving event of the Project.
Public delegateSectionChangedEventHandler
Represents the method that will handle the SectionChanged event.
Public delegateSelectionEventHandler
Represents a method that will handle the ObjectAdded and ObjectRemoved events.
Enumerations
  EnumerationDescription
Public enumerationBuiltinQuantity
Specifies the quantities which are supported.
Public enumerationCancelUndoStepType
Specifies how to cancel an undo step.
Public enumerationCollectionConflictPolicy
Specifies what to do when adding an item to a collection, if an equivalent item (e.g. same name) already exists in the collection.
Public enumerationLicenseHoldType
Specifies how an acquired license is released.
Public enumerationLicenseRuntime Obsolete.
Public enumerationLicenseType
Specifies the type of a license
Public enumerationLogMessageSeverity
Specifies the severity of a log message.
Public enumerationProjectDocumentFlags
Specifies values for the Flags property.
Public enumerationProjectDocumentType
Specifies the type of a ProjectDocument
Public enumerationProjectObjectChangeType
Specifies in which way a project object has changed.
Public enumerationProjectType
Specifies the type of a Project
Public enumerationQuantityAccelerationUnit
Specifies a unit of the quantity Acceleration
Public enumerationQuantityAngleUnit
Specifies a unit of the quantity Angle
Public enumerationQuantityAngularAccelerationUnit
Specifies a unit of the quantity AngularAcceleration
Public enumerationQuantityAngularElasticityUnit
Specifies a unit for the quantity Angular Elasticity
Public enumerationQuantityAngularVelocityUnit
Specifies a unit of the quantity AngularVelocity
Public enumerationQuantityAreaUnit
Specifies a unit of the quantity Area
Public enumerationQuantityElasticityUnit
Specifies a unit for the quantity Elasticity
Public enumerationQuantityEnergyUnit
Specifies a unit of the quantity Energy
Public enumerationQuantityForceUnit
Specifies a unit for the quantity Force
Public enumerationQuantityInertiaUnit
Specifies a unit of the quantity Inertia
Public enumerationQuantityLengthUnit
Specifies a unit of the quantity Length
Public enumerationQuantityMassUnit
Specifies a unit of the quantity Mass
Public enumerationQuantityNoneUnit
Specifies a unit of the quantity None
Public enumerationQuantityPowerUnit
Specifies a unit of the quantity Power
Public enumerationQuantityPressureUnit
Specifies a unit for the quantity Pressure (also used for Young's modulus)
Public enumerationQuantityQuaternionUnit
Specifies a unit for quaternions, to be able to specify decimals for the quaternions
Public enumerationQuantityTimeUnit
Specifies a unit of the quantity Time
Public enumerationQuantityTorqueUnit
Specifies a unit for the quantity Torque
Public enumerationQuantityVelocityUnit
Specifies a unit of the quantity Velocity
Public enumerationQuantityVolumeUnit
Specifies a unit of the quantity Volume
Public enumerationRecorderState
Specifies the different states that the ScreenRecorder can be in.
Public enumerationScreenRecorderFileFormat
Specifies the different output file formats supported by the ScreenRecorder.
Public enumerationSelectionReason
Reasons for why an object was added to a ProjectSelection.
Public enumerationSignalDataType
Specifies the data type of a DataRecorderSignal
Public enumerationSignalInterpolationType
Specifies the type of interpolation for a DataRecorderSignal