M

InstanceVoidCutUtils.AddInstanceVoidCut

Description:
Add a cut to an element using the unattached voids inside a cutting instance.

public static void AddInstanceVoidCut(
	Document document,
	Element element,
	Element cuttingInstance
)

Public Shared Sub AddInstanceVoidCut ( 
	document As Document,
	element As Element,
	cuttingInstance As Element
)

public:
static void AddInstanceVoidCut(
	Document^ document, 
	Element^ element, 
	Element^ cuttingInstance
)

static member AddInstanceVoidCut : 
        document : Document * 
        element : Element * 
        cuttingInstance : Element -> unit

Document

document

The document containing the two elements
Element

element

The element to be cut
Element

cuttingInstance

The cutting family instance

// Cut a beam with 3 instances of a void-cutting family
// The Family Parameter "Cut with Voids When Loaded" must be true for the cutting family
void CutBeamWithFamilyVoid(Autodesk.Revit.DB.Document doc, FamilyInstance beam, FamilySymbol cuttingSymbol)
{
    LocationCurve lc = beam.Location as LocationCurve;
    Curve beamCurve = lc.Curve;

    for (int i = 1; i <= 3; i++)
    {
        XYZ beamLocation = beamCurve.Evaluate(i * 0.25, true); // position on the beam for this cutting instance
        beamLocation = beamLocation - XYZ.BasisZ; // adjust for top-aligned curve

        Level level = doc.GetElement(beam.LevelId) as Level;
        FamilyInstance cuttingInstance = doc.Create.NewFamilyInstance(beamLocation, cuttingSymbol, level, StructuralType.NonStructural);
        InstanceVoidCutUtils.AddInstanceVoidCut(doc, beam, cuttingInstance);
    }
}

ArgumentException

The element cannot be cut with a void instance. -or- The element is not a family instance with an unattached void that can cut.
ArgumentNullException

A non-optional argument was null
ForbiddenForDynamicUpdateException

This method may not be called during dynamic update.
InvalidOperationException

Failed to cut element with the instances