Gebruikersinvoer en objectselectie in een AutoCAD C# add-in

De Editor als communicatiekanaal

De Editor is jouw verbinding met de AutoCAD-gebruiker. Via de Editor vraag je punten op, lees je waarden in, toon je berichten, en laat je de gebruiker objecten selecteren. Alle Get*-methoden van de Editor blokkeren het programma totdat de gebruiker invoer geeft of op Escape drukt — dat is exact het gedrag dat je wilt in een interactief commando.

// Haal altijd de Editor op via het actieve document
Document doc = Application.DocumentManager.MdiActiveDocument;
Editor   ed  = doc.Editor;

Een punt opvragen

De meest gebruikte invoer: de gebruiker klikt een punt in de tekening.

[CommandMethod("KLEVERPUNTTEST")]
public void PuntTest()
{
    Editor ed = Application.DocumentManager.MdiActiveDocument.Editor;

    // Stel de prompt in die de gebruiker ziet in de commandoregel
    PromptPointOptions opties = new PromptPointOptions("\nKlik een startpunt: ");
    opties.AllowNone = false; // Escape is niet toegestaan

    // Vraag het punt op — blokkeert totdat de gebruiker klikt of Escape drukt
    PromptPointResult resultaat = ed.GetPoint(opties);

    // Controleer altijd de status vóór je het resultaat gebruikt
    if (resultaat.Status != PromptStatus.OK)
    {
        ed.WriteMessage("\nGeannuleerd.");
        return;
    }

    Point3d punt = resultaat.Value;
    ed.WriteMessage($"\nGeselecteerd punt: X={punt.X:F2}, Y={punt.Y:F2}");
}

Een tweede punt met rubber-band lijn

Bij het opvragen van een tweede punt kun je een "rubber-band" lijn tonen vanuit het eerste punt:

// Vraag startpunt op
PromptPointResult start = ed.GetPoint("\nStartpunt: ");
if (start.Status != PromptStatus.OK) return;

// Vraag eindpunt op met rubber-band lijn vanuit het startpunt
PromptPointOptions eindOpties = new PromptPointOptions("\nEindpunt: ");
eindOpties.UseBasePoint = true;
eindOpties.BasePoint    = start.Value; // rubber-band trekt van dit punt

PromptPointResult eind = ed.GetPoint(eindOpties);
if (eind.Status != PromptStatus.OK) return;

// Nu heb je beide punten
double lengte = start.Value.DistanceTo(eind.Value);
ed.WriteMessage($"\nLengte: {lengte:F2}");

Tekst en getallen opvragen

// Tekst invoeren
PromptStringOptions tekstOpties = new PromptStringOptions("\nVoer een labelnaam in: ");
tekstOpties.AllowSpaces = true;        // spaties toegestaan in de invoer
PromptResult tekstResultaat = ed.GetString(tekstOpties);

if (tekstResultaat.Status != PromptStatus.OK) return;
string label = tekstResultaat.StringResult;

// Geheel getal invoeren
PromptIntegerOptions intOpties = new PromptIntegerOptions("\nAantal kopieën: ");
intOpties.DefaultValue = 1;   // standaardwaarde als gebruiker Enter drukt
intOpties.LowerLimit   = 1;   // minimum toegestane waarde
intOpties.UpperLimit   = 100; // maximum toegestane waarde
intOpties.AllowNone    = false;

PromptIntegerResult intResultaat = ed.GetInteger(intOpties);
if (intResultaat.Status != PromptStatus.OK) return;
int aantalKopieen = intResultaat.Value;

// Decimale waarde invoeren
PromptDoubleOptions dubbelOpties = new PromptDoubleOptions("\nStraal (mm): ");
dubbelOpties.DefaultValue   = 10.0;
dubbelOpties.AllowNegative  = false;
dubbelOpties.AllowZero      = false;

PromptDoubleResult dubbelResultaat = ed.GetDouble(dubbelOpties);
if (dubbelResultaat.Status != PromptStatus.OK) return;
double straal = dubbelResultaat.Value;

Eén object laten selecteren

Laat de gebruiker één entiteit aanwijzen in de tekening:

[CommandMethod("KLEVERENTITEITINFO")]
public void EntiteitInfo()
{
    Document doc = Application.DocumentManager.MdiActiveDocument;
    Editor   ed  = doc.Editor;
    Database db  = doc.Database;

    // Vraag de gebruiker om één object te selecteren
    PromptEntityOptions selectOpties = new PromptEntityOptions("\nSelecteer een object: ");
    selectOpties.SetRejectMessage("\nGeen geldig object — probeer opnieuw.");
    // Beperk tot specifiek type (optioneel):
    // selectOpties.AddAllowedClass(typeof(Line), exactMatch: true);

    PromptEntityResult selectResultaat = ed.GetEntity(selectOpties);
    if (selectResultaat.Status != PromptStatus.OK) return;

    // Lees de eigenschappen van de geselecteerde entiteit
    using (Transaction tr = db.TransactionManager.StartTransaction())
    {
        Entity ent = tr.GetObject(selectResultaat.ObjectId, OpenMode.ForRead) as Entity;

        ed.WriteMessage($"\nType:  {ent.GetType().Name}");
        ed.WriteMessage($"\nLaag:  {ent.Layer}");
        ed.WriteMessage($"\nKleur: {ent.Color}");

        tr.Commit();
    }
}

Meerdere objecten selecteren (SelectionSet)

Voor bulkbewerkingen laat je de gebruiker een selectieset maken:

[CommandMethod("KLEVERLAAGWISSEL")]
public void LaagWisselSelectie()
{
    Document doc = Application.DocumentManager.MdiActiveDocument;
    Editor   ed  = doc.Editor;
    Database db  = doc.Database;

    // Laat de gebruiker meerdere objecten selecteren
    // GetSelection() accepteert kader, window, kruisjes — alles wat AutoCAD kent
    PromptSelectionResult selectie = ed.GetSelection();

    if (selectie.Status != PromptStatus.OK)
    {
        ed.WriteMessage("\nNiets geselecteerd.");
        return;
    }

    SelectionSet set = selectie.Value;
    ed.WriteMessage($"\n{set.Count} object(en) geselecteerd.");

    // Vraag de doellaag op
    PromptResult laagInvoer = ed.GetString("\nNaam van doellaag: ");
    if (laagInvoer.Status != PromptStatus.OK) return;

    using (Transaction tr = db.TransactionManager.StartTransaction())
    {
        LayerTable lt = tr.GetObject(db.LayerTableId, OpenMode.ForRead) as LayerTable;

        // Controleer of de doellaag bestaat
        if (!lt.Has(laagInvoer.StringResult))
        {
            ed.WriteMessage($"\nLaag '{laagInvoer.StringResult}' bestaat niet.");
            return;
        }

        ObjectId doelLaagId = lt[laagInvoer.StringResult];
        int teller = 0;

        // Pas alle geselecteerde objecten aan
        foreach (SelectedObject selObj in set)
        {
            if (selObj == null) continue;

            Entity ent = tr.GetObject(selObj.ObjectId, OpenMode.ForWrite) as Entity;
            if (ent == null) continue;

            ent.LayerId = doelLaagId;
            teller++;
        }

        tr.Commit();
        ed.WriteMessage($"\n{teller} object(en) verplaatst naar laag '{laagInvoer.StringResult}'.");
    }
}

Selectie filteren op type of laag

Met een SelectionFilter beperk je de selectie tot specifieke objecttypes of laagnamen — de gebruiker kan dan alleen de relevante objecten aanwijzen:

// Filter: alleen lijnen op een specifieke laag
TypedValue[] filterWaarden = {
    new TypedValue((int)DxfCode.LayerName, "KC-CONSTRUCTIE"), // DXF 8 = laagnaam
    new TypedValue((int)DxfCode.Start,     "LINE")             // DXF 0 = objecttype
};

SelectionFilter filter = new SelectionFilter(filterWaarden);
PromptSelectionResult gefilterd = ed.GetSelection(filter);

if (gefilterd.Status == PromptStatus.OK)
{
    ed.WriteMessage($"\n{gefilterd.Value.Count} lijn/lijnen op laag KC-CONSTRUCTIE geselecteerd.");
}

Conclusie

De Editor API geeft je alles wat je nodig hebt voor professionele gebruikersinteractie: punten, tekst, getallen, enkelvoudige selectie en selectiesets met filters. Combineer dit met de entiteits- en laagbeheer uit de vorige posts en je hebt de bouwstenen voor vrijwel elk AutoCAD-automatiseringsscenario.

The Editor object

All user interaction in AutoCAD add-ins goes through the Editor object. You get it from the active document:

using Autodesk.AutoCAD.ApplicationServices;
using Autodesk.AutoCAD.EditorInput;

Document doc = Application.DocumentManager.MdiActiveDocument;
Editor ed = doc.Editor;

The Editor has methods for every type of input: GetPoint, GetDistance, GetString, GetInteger, GetDouble, GetEntity, and GetSelection.

Asking for a point

[CommandMethod("GETPOINT")]
public void GetPointCommand()
{
    Document doc = Application.DocumentManager.MdiActiveDocument;
    Editor ed = doc.Editor;

    // Build the options object — this is where you set the prompt message,
    // keyword list, default value, etc.
    var options = new PromptPointOptions("\nPick a point: ");
    options.AllowNone = false;  // User must pick something (no Enter to skip)

    PromptPointResult result = ed.GetPoint(options);

    if (result.Status == PromptStatus.OK)
    {
        // result.Value is a Point3d
        ed.WriteMessage($"\nYou picked: X={result.Value.X:F2}, Y={result.Value.Y:F2}");
    }
    else
    {
        // User pressed Escape or cancelled
        ed.WriteMessage("\nCancelled.");
    }
}

Asking for a distance

var distOptions = new PromptDistanceOptions("\nEnter a distance: ");
distOptions.DefaultValue = 100.0;
distOptions.UseDefaultValue = true;

PromptDoubleResult distResult = ed.GetDistance(distOptions);

if (distResult.Status == PromptStatus.OK)
{
    double distance = distResult.Value;
    ed.WriteMessage($"\nDistance: {distance:F2}");
}

Asking for a string (text input)

var strOptions = new PromptStringOptions("\nEnter a layer name: ");
strOptions.AllowSpaces = false;
strOptions.DefaultValue = "0";
strOptions.UseDefaultValue = true;

PromptResult strResult = ed.GetString(strOptions);

if (strResult.Status == PromptStatus.OK)
{
    string layerName = strResult.StringResult;
    ed.WriteMessage($"\nLayer: {layerName}");
}

Selecting a single entity

var entOptions = new PromptEntityOptions("\nSelect an object: ");
entOptions.SetRejectMessage("\nThat is not a valid entity.");
entOptions.AddAllowedClass(typeof(Line), exactMatch: false);  // Only accept Lines (and subclasses)

PromptEntityResult entResult = ed.GetEntity(entOptions);

if (entResult.Status == PromptStatus.OK)
{
    Database db = doc.Database;
    using (Transaction tr = db.TransactionManager.StartTransaction())
    {
        Entity ent = tr.GetObject(entResult.ObjectId, OpenMode.ForRead) as Entity;
        ed.WriteMessage($"\nSelected: {ent.GetType().Name} on layer '{ent.Layer}'");
        tr.Commit();
    }
}

Selecting multiple entities

// Ask the user to pick a selection set (crossing window, individual picks, etc.)
PromptSelectionResult selResult = ed.GetSelection();

if (selResult.Status == PromptStatus.OK)
{
    SelectionSet ss = selResult.Value;
    ed.WriteMessage($"\n{ss.Count} object(s) selected.");

    Database db = doc.Database;
    using (Transaction tr = db.TransactionManager.StartTransaction())
    {
        foreach (SelectedObject selObj in ss)
        {
            Entity ent = tr.GetObject(selObj.ObjectId, OpenMode.ForWrite) as Entity;
            if (ent != null)
                ent.Layer = "CONSTRUCTION";  // Move all selected objects to CONSTRUCTION layer
        }
        tr.Commit();
    }
}

Using keywords for menu-like choices

var options = new PromptPointOptions(
    "\nPick start point [Rectangle/Circle/Line] <Line>: ");

options.Keywords.Add("Rectangle");
options.Keywords.Add("Circle");
options.Keywords.Add("Line");
options.Keywords.Default = "Line";

PromptPointResult result = ed.GetPoint(options);

switch (result.Status)
{
    case PromptStatus.OK:
        // User picked a point — draw whatever shape was last selected
        break;
    case PromptStatus.Keyword:
        ed.WriteMessage($"\nChosen: {result.StringResult}");
        // Switch on result.StringResult to handle each keyword
        break;
    default:
        // Cancelled
        break;
}

Always check PromptStatus

Never assume input was successful. Always check result.Status == PromptStatus.OK before using the value. If the user presses Escape, the status will be PromptStatus.Cancel — your command should exit cleanly in that case.