M

PointLoad.Create

Description:
Creates a new custom hosted point load within the project using data at point.

Overloads (2):

Create

Create(Document,ElementId,AnalyticalElementSelector,XYZ,XYZ,PointLoadType)

Create(Document,ElementId,XYZ,XYZ,XYZ,PointLoadType)

public static PointLoad Create(
	Document document,
	ElementId hostElemId,
	XYZ point,
	XYZ forceVector,
	XYZ momentVector,
	PointLoadType symbol
)

Public Shared Function Create ( 
	document As Document,
	hostElemId As ElementId,
	point As XYZ,
	forceVector As XYZ,
	momentVector As XYZ,
	symbol As PointLoadType
) As PointLoad

public:
static PointLoad^ Create(
	Document^ document, 
	ElementId^ hostElemId, 
	XYZ^ point, 
	XYZ^ forceVector, 
	XYZ^ momentVector, 
	PointLoadType^ symbol
)

static member Create : 
        document : Document * 
        hostElemId : ElementId * 
        point : XYZ * 
        forceVector : XYZ * 
        momentVector : XYZ * 
        symbol : PointLoadType -> PointLoad

Document

document

Document to which new point load will be added.
ElementId

hostElemId

The AnalyticalElement host element for the point Load.
XYZ

point

The position of point load, measured in decimal feet.
XYZ

forceVector

The applied 3d force vector.
XYZ

momentVector

The applied 3d moment vector.
PointLoadType

symbol

The symbol of the PointLoad. Set null to use default type.

Return Value PointLoad If successful, returns the newly created PointLoad, otherwise.

Document document = commandData.Application.ActiveUIDocument.Document;
UIDocument activeDoc = commandData.Application.ActiveUIDocument;

//select object for adding a point load
Reference eRef = activeDoc.Selection.PickObject(ObjectType.Element, "Please select the analytical element");
ElementId selectedElementId = null;
if (eRef != null && eRef.ElementId != ElementId.InvalidElementId)
   selectedElementId = eRef.ElementId;

XYZ location = activeDoc.Selection.PickPoint("Point Load location");

using (Transaction transaction = new Transaction(document, "Create custom PointLoad"))
{
   transaction.Start();
   PointLoad pointLoad = null;

   if (PointLoad.IsPointInsideHostBoundaries(document, selectedElementId, location))
      pointLoad = PointLoad.Create(document, selectedElementId, location, new XYZ(1, 0, 0), new XYZ(1, 0, 0), null);

   transaction.Commit();
}

Dim document As Document = commandData.Application.ActiveUIDocument.Document
Dim activeDoc As UIDocument = commandData.Application.ActiveUIDocument

'select object for adding a point load
Dim eRef As Reference = activeDoc.Selection.PickObject(ObjectType.Element, "Please select the analytical element")
Dim selectedElementId As ElementId = Nothing
If eRef IsNot Nothing AndAlso eRef.ElementId IsNot ElementId.InvalidElementId Then selectedElementId = eRef.ElementId

Dim location As XYZ = activeDoc.Selection.PickPoint("Point Load location")

Using transaction As Transaction = New Transaction(document, "Create custom PointLoad")
    transaction.Start()
    Dim pointLoad As PointLoad = Nothing

    If PointLoad.IsPointInsideHostBoundaries(document, selectedElementId, location) Then pointLoad = PointLoad.Create(document, selectedElementId, location, New XYZ(1, 0, 0), New XYZ(1, 0, 0), Nothing)

    transaction.Commit()

ArgumentException

hostElemId is not permitted for this type of load. -or- Thrown when work plane is not valid.
ArgumentNullException

A non-optional argument was null
ArgumentsInconsistentException

Thrown when force and moment vectors are equal zero.
InvalidOperationException

Thrown if type could not be set for newly created point load.