M

Document.NewRoom

Description:
Creates a new room within the confines of a plan circuit, or places an unplaced room within the confines of the plan circuit.

Remarks:
This method will regenerate the document even in manual regeneration mode.

Overloads (3):

NewRoom

NewRoom(Level,UV)

NewRoom(Phase)

NewRoom(Room,PlanCircuit)

public Room NewRoom(
	Room room,
	PlanCircuit circuit
)

Public Function NewRoom ( 
	room As Room,
	circuit As PlanCircuit
) As Room

public:
Room^ NewRoom(
	Room^ room, 
	PlanCircuit^ circuit
)

member NewRoom : 
        room : Room * 
        circuit : PlanCircuit -> Room

Room

room

The room which you want to locate in the circuit. Pass null to create a new room.
PlanCircuit

circuit

The circuit in which you want to locate a room.

Return Value Room If successful the room is returned, otherwise .

InvalidOperationException

If the existing room is already placed.
ArgumentException

Thrown if the room does not exist in the given document.
ArgumentException

Thrown if the circuit does not exist in the given document.
InvalidOperationException

Thrown if the level obtained from the circuit has no associated view .