Show / Hide Table of Contents

Class Group

Represents a group of entities.

Inheritance
System.Object
DxfObject
TableObject
Group
Implements
IHasXData
System.ICloneable
System.IComparable
System.IComparable<TableObject>
System.IEquatable<TableObject>
Inherited Members
TableObject.NameChanged
TableObject.OnNameChangedEvent(String, String)
TableObject.XDataAddAppReg
TableObject.OnXDataAddAppRegEvent(ApplicationRegistry)
TableObject.XDataRemoveAppReg
TableObject.OnXDataRemoveAppRegEvent(ApplicationRegistry)
TableObject.IsReserved
TableObject.InvalidCharacters
TableObject.XData
TableObject.IsValidName(String)
TableObject.ToString()
TableObject.CompareTo(Object)
TableObject.CompareTo(TableObject)
TableObject.GetHashCode()
TableObject.Equals(Object)
TableObject.Equals(TableObject)
DxfObject.CodeName
DxfObject.Handle
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: netDxf.Objects
Assembly: CADability.dll
Syntax
public class Group : TableObject, IHasXData, ICloneable, IComparable, IComparable<TableObject>, IEquatable<TableObject>

Constructors

| Improve this Doc View Source

Group()

Initialized a new unnamed empty group.

Declaration
public Group()
Remarks

A unique name will be generated when the group is added to the document.

| Improve this Doc View Source

Group(IEnumerable<EntityObject>)

Initialized a new group with the specified entities.

Declaration
public Group(IEnumerable<EntityObject> entities)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<EntityObject> entities

The list of entities contained in the group.

Remarks

A unique name will be generated when the group is added to the document.

| Improve this Doc View Source

Group(String)

Initialized a new empty group.

Declaration
public Group(string name)
Parameters
Type Name Description
System.String name

Group name.

Remarks

If the name is set to null or empty, a unique name will be generated when the group is added to the document.

| Improve this Doc View Source

Group(String, IEnumerable<EntityObject>)

Initialized a new group with the specified entities.

Declaration
public Group(string name, IEnumerable<EntityObject> entities)
Parameters
Type Name Description
System.String name

Group name (optional).

System.Collections.Generic.IEnumerable<EntityObject> entities

The list of entities contained in the group.

Remarks

If the name is set to null or empty, a unique name will be generated when the group is added to the document.

Properties

| Improve this Doc View Source

Description

Gets or sets the description of the group.

Declaration
public string Description { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Entities

Gets the list of entities contained in the group.

Declaration
public EntityCollection Entities { get; }
Property Value
Type Description
EntityCollection
Remarks

When the group is added to the document the entities in it will be automatically added too.
An entity may be contained in different groups.

| Improve this Doc View Source

IsSelectable

Gets or sets if the group is selectable.

Declaration
public bool IsSelectable { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

IsUnnamed

Gets if the group has an automatic generated name.

Declaration
public bool IsUnnamed { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

Name

Gets the name of the table object.

Declaration
public string Name { get; set; }
Property Value
Type Description
System.String
Remarks

Table object names are case insensitive.

| Improve this Doc View Source

Owner

Gets the owner of the actual DXF object.

Declaration
public Groups Owner { get; }
Property Value
Type Description
Groups

Methods

| Improve this Doc View Source

Clone()

Creates a new Group that is a copy of the current instance.

Declaration
public override object Clone()
Returns
Type Description
System.Object

A new Group that is a copy of this instance.

Overrides
TableObject.Clone()
| Improve this Doc View Source

Clone(String)

Creates a new Group that is a copy of the current instance.

Declaration
public override TableObject Clone(string newName)
Parameters
Type Name Description
System.String newName

Group name of the copy.

Returns
Type Description
TableObject

A new Group that is a copy of this instance.

Overrides
TableObject.Clone(String)
Remarks

The entities that belong to the group will also be cloned.

| Improve this Doc View Source

OnEntityAddedEvent(EntityObject)

Declaration
protected virtual void OnEntityAddedEvent(EntityObject item)
Parameters
Type Name Description
EntityObject item
| Improve this Doc View Source

OnEntityRemovedEvent(EntityObject)

Declaration
protected virtual void OnEntityRemovedEvent(EntityObject item)
Parameters
Type Name Description
EntityObject item

Events

| Improve this Doc View Source

EntityAdded

Declaration
public event Group.EntityAddedEventHandler EntityAdded
Event Type
Type Description
Group.EntityAddedEventHandler
| Improve this Doc View Source

EntityRemoved

Declaration
public event Group.EntityRemovedEventHandler EntityRemoved
Event Type
Type Description
Group.EntityRemovedEventHandler

Implements

IHasXData
System.ICloneable
System.IComparable
System.IComparable<T>
System.IEquatable<T>
  • Improve this Doc
  • View Source
In This Article
Back to top Generated by DocFX