M

BoundaryConditions.IsValidHostId

Description:
Checks if the provided host id can host a boundary conditions of the provided type.

public static bool IsValidHostId(
	Document doc,
	ElementId hostId,
	BoundaryConditionsType type
)

Public Shared Function IsValidHostId ( 
	doc As Document,
	hostId As ElementId,
	type As BoundaryConditionsType
) As Boolean

public:
static bool IsValidHostId(
	Document^ doc, 
	ElementId^ hostId, 
	BoundaryConditionsType type
)

static member IsValidHostId : 
        doc : Document * 
        hostId : ElementId * 
        type : BoundaryConditionsType -> bool

Document

doc

The document containing both the host and the boundary conditions.
ElementId

hostId

The id of the analytical element that is about to host a boundary conditions.
BoundaryConditionsType

type

The type of the boundary conditions that is about to be hosted.

Return Value Boolean True if an area boundary conditions can be placed on the input host id.

ArgumentNullException

A non-optional argument was null
ArgumentOutOfRangeException

A value passed for an enumeration argument is not a member of that enumeration

Loading…

Syntax