Class ProjectObject
Abstract base class for all objects that can be part of a Project. It can not be instantiated.
Inheritance
ProjectObject
Assembly: ABB.Robotics.RobotStudio.dll
Syntax
public abstract class ProjectObject
Constructors
ProjectObject()
Declaration
protected ProjectObject()
ProjectObject(PimDocument)
Declaration
protected ProjectObject(PimDocument doc)
Parameters
Type |
Name |
Description |
RobotStudio.API.Persistence.PimDocument |
doc |
|
Fields
_curUndoDeltaState
Declaration
Compliant(false)]
protected int _curUndoDeltaState
Field Value
Properties
Attributes
Returns a collection of dynamic attributes attached to the object
Declaration
public AttributeCollection Attributes { get; }
Property Value
Children
Enumerates all child objects.
Declaration
public IEnumerable<ProjectObject> Children { get; }
Property Value
ContainingProject
Returns the Project that this object is a part of, or null if it is
not part of a Project.
Declaration
public Project ContainingProject { get; }
Property Value
DisplayName
Gets the name of the the object that should be displayed in the GUI.
Declaration
public virtual string DisplayName { get; }
Property Value
InternalChildren
Declaration
protected CmList<ProjectObject> InternalChildren { get; }
Property Value
InternalParent
Declaration
protected ProjectObject InternalParent { get; set; }
Property Value
Name
Gets or sets the name of the object
Declaration
public virtual string Name { get; set; }
Property Value
NativeObject
Declaration
olete("No longer supported")]
public object NativeObject { get; }
Property Value
Parent
Returns the objects parent, if it has one.
Declaration
public virtual ProjectObject Parent { get; }
Property Value
TypeDisplayName
Gets a localized name for the type of this object.
Declaration
public string TypeDisplayName { get; }
Property Value
UIVisible
Gets or sets a value that indicates if this object should be displayed in GUI
such as an object browser.
Declaration
public bool UIVisible { get; set; }
Property Value
UniqueId
Gets a persisted, globally unique identifier for this object, that can be used
to find the object using the GetObjectFromUniqueId(String) method.
Declaration
public string UniqueId { get; }
Property Value
Methods
AfterLoad(PimDocument)
Declaration
protected virtual void AfterLoad(PimDocument doc)
Parameters
Type |
Name |
Description |
RobotStudio.API.Persistence.PimDocument |
doc |
|
Backup(Boolean)
Declaration
protected void Backup(bool evenIfNew = false)
Parameters
Type |
Name |
Description |
Boolean |
evenIfNew |
|
BeforeSave(PimDocument)
Declaration
protected virtual void BeforeSave(PimDocument doc)
Parameters
Type |
Name |
Description |
RobotStudio.API.Persistence.PimDocument |
doc |
|
FindObjects(Predicate<ProjectObject>, Predicate<ProjectObject>)
Recursively finds object that satisfy a condition.
Declaration
public IEnumerable<ProjectObject> FindObjects(Predicate<ProjectObject> filter, Predicate<ProjectObject> recurse)
Parameters
Returns
NotifyChange()
Declaration
protected void NotifyChange()
NotifyChange(ProjectObjectChangeType)
Declaration
protected void NotifyChange(ProjectObjectChangeType chType)
Parameters
OnCreatingObject()
Declaration
protected virtual void OnCreatingObject()
OnDelete()
Declaration
protected virtual void OnDelete()
OnRemove(Project)
Called when removed from a project.
Declaration
protected virtual void OnRemove(Project project)
Parameters
Type |
Name |
Description |
Project |
project |
The old parent project.
|
OnUndoRedo()
Declaration
protected virtual void OnUndoRedo()
ToString()
Declaration
public override string ToString()
Returns
Overrides
Events
DisplayNameChanged
Declaration
olete("Not supported")]
public static event ProjectObjectPropertyChangedEventHandler DisplayNameChanged
Event Type
InternalEvent
Declaration
public static event Action<ProjectObject, InternalEventType, object> InternalEvent
Event Type
ProjectObjectChanged
Occurs when the ProjectObject is changed
Declaration
public static event ProjectObjectChangedEventHandler ProjectObjectChanged
Event Type