Click or drag to resize
Frame Class
Represents a simple modelling frame.
Inheritance Hierarchy

Namespace:  ABB.Robotics.RobotStudio.Stations
Assembly:  ABB.Robotics.RobotStudio.Stations (in ABB.Robotics.RobotStudio.Stations.dll) Version: 7.0.8747.636
Syntax
C#
public sealed class Frame : ProjectObject, 
	IHasTransform, IAttachableChild, IAttachableParent

The Frame type exposes the following members.

Constructors
  NameDescription
Public methodCode exampleFrame
Initializes a new instance of the Frame class.
Top
Properties
  NameDescription
Public propertyAttributes
Returns a collection of dynamic attributes attached to the object
(Inherited from ProjectObject.)
Public propertyChildren
Enumerates all child objects.
(Inherited from ProjectObject.)
Public propertyContainingProject
Returns the Project that this object is a part of, or null if it is not part of a Project.
(Inherited from ProjectObject.)
Public propertyDisplayName
Gets the name of the the object that should be displayed in the GUI.
(Inherited from ProjectObject.)
Public propertyCode exampleFrameSize
Gets or sets the size of the graphical frame.
Public propertyFrameType
Gets or sets a value indicating how the frame is used.
Public propertyName
Gets or sets the name of the object
(Overrides ProjectObjectName.)
Public propertyCode exampleParent
Returns a reference to the parent Station.
(Overrides ProjectObjectParent.)
Public propertyCode exampleShowName
Gets or sets a value indicating whether the name of the frame will be displayed in the graphics.
Public propertyCode exampleTransform
Gets the transform of the Frame.
Public propertyTypeDisplayName
Gets a localized name for the type of this object.
(Inherited from ProjectObject.)
Public propertyUIVisible
Gets or sets a value that indicates if this object should be displayed in GUI such as an object browser.
(Inherited from ProjectObject.)
Public propertyUniqueId
Gets a persisted, globally unique identifier for this object, that can be used to find the object using the GetObjectFromUniqueId(String) method.
(Inherited from ProjectObject.)
Public propertyCode exampleVisible
Gets or sets a value indicating whether the frame will be displayed in the graphics.
Top
Methods
  NameDescription
Public methodAttach
Attaches an IAttachableChild to this frame.
Public methodCanAttachChild
Checks if an IAttachableChild can be attached to this frame.
Public methodDetach
Detaches an attached object from this frame.
Public methodEquals (Inherited from Object.)
Public methodFindObjects
Recursively finds object that satisfy a condition.
(Inherited from ProjectObject.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Public methodHighlight
Sets the highlight color of the frame to the default highlight color.
Public methodHighlight(Color)
Sets the highlight color of the frame.
Public methodResetHighlight
Resets the highlight color of the target to the default color.
Public methodToString (Inherited from ProjectObject.)
Top
Examples
Frame Example.
Frame Properties Example
Project.UndoContext.BeginUndoStep("FrameProperties");
try
{
    Station station = Station.ActiveStation;

    // Create a frame.
    Frame myFrame = new Frame();
    myFrame.Name = "MyFrame_1";

    // Add the frame to the station.
    station.Frames.Add(myFrame);

    // Make the frame twice as big.
    myFrame.FrameSize = myFrame.FrameSize * 2;

    // Make sure the name of the frame and the frame itself is displayed in the graphics.
    myFrame.ShowName = true;
    myFrame.Visible = true;

    // Move the frame 100 mm along the X-axis.
    myFrame.Transform.X = myFrame.Transform.X + 0.1;

    // Output the transform of the frame.
    Logger.AddMessage(new LogMessage("Transform: x:" + myFrame.Transform.X.ToString() +
                                                    " y:" + myFrame.Transform.Y.ToString() +
                                                    " z:" + myFrame.Transform.Z.ToString() +
                                                    " Rx:" + myFrame.Transform.RX.ToString() +
                                                    " Ry:" + myFrame.Transform.RY.ToString() +
                                                    " Rz:" + myFrame.Transform.RZ.ToString()));
}
catch
{
    Project.UndoContext.CancelUndoStep(CancelUndoStepType.Rollback);
    throw;
}
finally
{
    Project.UndoContext.EndUndoStep();
}
Version Information

Supported in: 1.0.0.0
See Also