https://github.com/wtertinek/linq2acad
A library that aims to simplify AutoCAD .NET plugin code
https://github.com/wtertinek/linq2acad
autocad csharp dotnet linq
Last synced: 10 months ago
JSON representation
A library that aims to simplify AutoCAD .NET plugin code
- Host: GitHub
- URL: https://github.com/wtertinek/linq2acad
- Owner: wtertinek
- License: mit
- Created: 2015-05-15T15:18:01.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2024-05-29T22:08:06.000Z (about 2 years ago)
- Last Synced: 2025-04-07T12:08:24.552Z (about 1 year ago)
- Topics: autocad, csharp, dotnet, linq
- Language: C#
- Homepage:
- Size: 7.34 MB
- Stars: 65
- Watchers: 10
- Forks: 35
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Linq2Acad
A library that aims to simplify AutoCAD .NET plugin code. Available for `AutoCAD 2015` and later.
### Overview
- [News](#news)
- [Getting started](#getting-started)
- [Installation](#installation)
- [API documentation](#api-documentation)
- [How it works](#how-it-works)
- [Contributing](#contributing)
- [License](#license)
# News
**Linq2Acad-2024** is now available on [NuGet](https://www.nuget.org/packages/Linq2Acad-2024/).
## Getting started
`Linq2Acad` is a library that aims to simplify AutoCAD .NET plugin code. It should be a more intuitive API for working with the drawing database, making the learning curve for beginners less steep.
#### As a simple example, let's print all layer names using Linq2Acad:
```cs
using (var db = AcadDatabase.Active())
{
var layerNames = db.Layers.Select(l => l.Name);
MessageBox.Show(string.Join(", ", layerNames));
}
```
#### Linq2Acad makes it easy to delete all BlockReferences from the model space:
```cs
using (var db = AcadDatabase.Active())
{
foreach (var br in db.ModelSpace
.OfType()
.UpgradeOpen())
{
br.Erase();
}
}
```
#### This code shows how to import a block from a DWG file into the active document:
```cs
using (var sourceDb = AcadDatabase.OpenReadOnly(@"C:\Blocks\Shapes.dwg"))
using (var targetDb = AcadDatabase.Active())
{
var block = sourceDb.Blocks.Element("TRIANGLE");
targetDb.Blocks.Import(block);
}
```
#### You can easily store data on entities:
```c#
var entityId = GetEntity("Pick an Entity");
var key = GetString("Enter key");
var str = GetString("Enter string to save");
// We first write the data (it is stored in the Entity's extension data)
using (var db = AcadDatabase.Active())
{
db.CurrentSpace
.Element(entityId)
.SaveData(key, str);
WriteMessage($"Key-value-pair {key}:{str} saved on Entity");
}
// Then we read it back
using (var db = AcadDatabase.Active())
{
var str = db.CurrentSpace
.Element(entityId)
.GetData(key);
WriteMessage($"String {str} read from Entity");
}
```
#### You can use Linq2Acad to changes the summary info of the active document:
```cs
using (var db = AcadDatabase.Active())
{
db.SummaryInfo.Author = "John Doe";
db.SummaryInfo.CustomProperties["CustomData1"] = "42";
}
```
#### There's also a simple way to, for example, reload all loaded XRefs:
```cs
using (var db = AcadDatabase.Active())
{
foreach (var xRef in db.XRefs
.Where(xr => xr.IsLoaded))
{
xRef.Reload();
}
}
```
More code samples (in C# and VB.NET) can be found [here](docs/CodeSamples.md).
## Installation
### NuGet packages
Linq2Acad is available on NuGet. There is a dedicated Linq2Acad package for each AutoCAD version. Simply add the package for your AutoCAD version to your C#/VB project in Visual Studio. Available packages:
### How to upgrade from source code to NuGet
1. Remove your existing Linq2Acad project completely from your existing Visual Studio solution (You should see a lot of red squiggly lines)
2. Install the NuGet Package
(If you add NuGet while already having a Linq2Acad project there, and THEN you subsequently remove the latter project - you might have a lot of problems)
## API documentation
The best entry point into the API documentation is the class [AcadDatabase](docs/api/T_Linq2Acad_AcadDatabase.md#AcadDatabase-Class). An overview of all classes can be found [here](docs/api/Index.md#Linq2Acad-Namespace).
## How it works?
[This blog series](https://wtertinek.com/2016/07/06/linq-and-the-autocad-net-api-final-part) discusses:
- the original problem this library seeks to solve,
- the design / implementation decisions involved in deriving the API.
## Contributing
We would love for you to contribute to Linq2Acad and help to make the life of AutoCAD plugin developers easier. We welcome ideas, suggestions and discussions to push the development forward. Implementation of bugfixes or new features are also always welcome. For details see the [contributing guidelines](.github/CONTRIBUTING.md).
## License
Linq2Acad is licended unter the [MIT License (MIT)](LICENSE).