DXFReaderNETControl Class

The main component that allows viewing, manipulating and plotting any 2D/3D DXF file. With this control you can also retrieve every drawing information and every entity and easily perform data manipulation and/or analysis. With DXFReader you can also import and scale a raster image to use together with the drawing.

Inheritance Hierarchy

SystemObject
  SystemMarshalByRefObject
    System.ComponentModelComponent
      System.Windows.FormsControl
        System.Windows.FormsScrollableControl
          System.Windows.FormsContainerControl
            System.Windows.FormsUserControl
              DXFReaderNETDXFReaderNETControl

Namespace: DXFReaderNET
Assembly: DXFReaderNET (in DXFReaderNET.dll) Version: 20.10.54

Syntax

C++

Copy

public class DXFReaderNETControl : UserControl

Public Class DXFReaderNETControl
	Inherits UserControl

public ref class DXFReaderNETControl : public UserControl

type DXFReaderNETControl =  
    class
        inherit UserControl
    end

 CLASS DXFReaderNETControl INHERIT UserControl

The DXFReaderNETControl type exposes the following members.

Constructors

	Name	Description
	DXFReaderNETControl	The main component that allows viewing, manipulating and plotting any 2D/3D DXF file. With this control you can also retrieve every drawing information and every entity and easily perform data manipulation and/or analysis. With DXFReader you can also import and scale a raster image to use together with the drawing.

Top

Properties

	Name	Description
	AntiAlias	Returns/sets whether the control will display with antialias rendering.
	AxesColor	Returns/sets the color used to display the limits box.
	AxisXColor	Returns/sets the color used to X axis.
	AxisYColor	Returns/sets the color used to Y axis.
	AxisZColor	Returns/sets the color used to Z axis.
	BackColor	Returns/sets the background color.
	Base	Returns/sets the base point of the drawing.
	ContinuousHighlight	Returns/sets if then highlighted entities are continuosly shown after zoom or redraw.
	CurrentWCSpoint	Returns the current point in world coordinates.
	CursorSelectionSize	Returns/sets the pickbox size in pixel of the selection cursor.
	CustomCursor	Gets or sets the custom cursor that is displayed when the mouse pointer is over the control.
	CustomCursorColor	Gets or sets the color of custom cursor.
	DistributionCode	Sets the Distribution Code, provided during the component registration, to enable the distribution of the DLL file along with the compiled program.
	DrawTime	Returns the time needed to draw a DXF file.
	DXF	The DXF document currently loaded/displayed in the control.
	FileName	Returns/sets the DXF file to display in the control.
	ForeColor	Returns/sets the foreground color used to display graphics in the control.
	GridColor	Returns/sets the color used to display the grid's lines in the control.
	GridDisplay	Returns/sets the grid display mode.
	HighlightColor	Returns/sets the color used to display highlited entities.
	HighlightEntityOnHover	Gets/sets if the entity is highlighted on cursor hover.
	HighlightGrabPoints	Gets/sets the display of of grab points.
	HighlightGrabPointsColor	Returns/sets the color used to display the highlighted grab points.
	HighlightMarkerColor	Returns/sets the color used to display the marks of highlighted entities.
	HighlightMarkerColor2	Returns/sets the color used to display the secondary marks of highlighted entities.
	HighlightNotContinuous	Gets/sets the display of unconnected points.
	Image	Gets the image that is displayed by the control.
	LowerLeftCorner	Returns the lower left corner of visible area in world coordinates.
	MouseWheelBehavior	Returns/sets the scroll behavior of the mouse wheel for the control.
	ObjectOsnapMode	Gets/sets the object osnap type mode.
	PlotAspectRatio	Returns/sets the aspect ratio of the plotted drawing. This aspect ratio is the relationship between the drawing's two dimensions, expressed as width divided by height.
	PlotMarginBottom	Returns/sets the bottom margin of the plotting page.
	PlotMarginLeft	Returns/sets the left margin of the plotting page.
	PlotMarginRight	Returns/sets the right margin of the plotting page.
	PlotMarginTop	Returns/sets the top margin of the plotting page.
	PlotMode	Returns/sets the current plotting mode.
	PlotOffset	Returns/sets the lower-left corner of the plottable area.
	PlotPenWidth	Returns/sets the width (in drawing units) of the plotted lines or arcs.
	PlotRendering	Returns/sets the rendering modes on color/bw printers.
	PlotRotation	Returns/sets the orientation of the plotted drawing.
	PlotScale	Returns/sets the plot scale factor.
	PlotTime	Returns the time needed to plot a DXF file.
	PlotUnits	Returns/sets the current plotting units.
	ReadTime	Returns the time needed to read a DXF file.
	Rendering	Returns/sets the rendering modes.
	RubberBandPenWidth	Returns/sets the width in pixel of the pen used to draw rubber band lines.
	ShowAxes	Returns/sets whether the control will display the axes.
	ShowBasePoint	Returns/sets whether the control will display the base point.
	ShowExtents	Returns/sets whether the control will display the drawing extents.
	ShowGrid	Returns/sets whether the control will display the grid.
	ShowGridRuler	Gets/sets the displaying of grid ruler.
	ShowLimits	Returns/sets whether the control will display the drawing limits.
	TrueTypeFontDir	Returns/sets the additional true type fonts directory.
	UnconnectedPointsColor	Returns/sets the color used to mark unconnected points.
	UpperRightCorner	Returns the upper right corner of visible area in world coordinates.
	Version	Returns the current version of the control.
	WriteTime	Returns the time needed to read a DXF file.
	ZoomInOutPercent	Returns/sets the increase/decrease factor (x 100) for zooming using ZoomIn, ZoomOut, ZoomSpotIn and ZoomSpotOut methods.

Top

Methods

	Name	Description
	About	Displays the About Box.
	AddAlignedDimension(Line, Vector3, String, Int16, String, String)	Adds a new aligned dimension to the current drawing giving the reference line and the position of the dimension.
	AddAlignedDimension(Line, Double, String, Int16, String, String)	Adds a new aligned dimension to the current drawing giving the reference line and the distance offset from the reference line.
	AddAlignedDimension(Vector3, Vector3, Vector3, String, Int16, String, String)	Adds a new aligned dimension to the current drawing with start point, end point and position of the dimension.
	AddAlignedDimension(Vector3, Vector3, Double, String, Int16, String, String)	Adds a new aligned dimension to the current drawing with start point, end point and the distance offset from the reference line.
	AddAngularDimension(Arc, Vector3, String, Int16, String, String)	Adds a new angular dimension to the current drawing giving an arc.
	AddAngularDimension(Arc, Double, String, Int16, String, String)	Adds a new angular dimension to the current drawing giving arc and offset.
	AddAngularDimension(Line, Line, Vector3, String, Int16, String, String)	Adds a new angular dimension to the current drawing giving two reference lines and the position.
	AddAngularDimension(Line, Line, Double, String, Int16, String, String)	Adds a new angular dimension to the current drawing giving two reference lines and the offeset from center point.
	AddAngularDimension(Vector3, Vector3, Vector3, Vector3, String, Int16, String, String)	Adds a new angular dimension to the current drawing giving center point, start point and end point.
	AddAngularDimension(Vector3, Vector3, Vector3, Double, String, Int16, String, String)	Adds a new angular dimension to the current drawing giving center point, start point, end point and the distance offset from the reference arc.
	AddArc(Vector3, Vector3, Vector3, Int16, String, String)	Adds a new arc to the current drawing specifing start point, end point and a pont on arc.
	AddArc(Vector3, Double, Vector3, Vector3, Int16, String, String)	Adds a new arc to the current drawing specifing center point, radius, start point and end point.
	AddArc(Vector3, Double, Double, Double, Int16, String, String)	Adds a new arc to the current drawing specifing center point, radius, start angle and end angle.
	AddBlock	Adds a new block to the current drawing.
	AddCircle(Vector3, Double, Int16, String, String)	Adds a new circle to the current drawing with center and radius.
	AddCircle(Vector3, Vector3, Vector3, Int16, String, String)	Adds a new circle to the current drawing passing from three points.
	AddDiametricDimension(Arc, Vector3, String, Int16, String, String)	Adds a new diametric dimension to the current drawing giving the reference arc.
	AddDiametricDimension(Circle, Vector3, String, Int16, String, String)	Adds a new diametric dimension to the current drawing giving the reference circle.
	AddDiametricDimension(Arc, Double, Double, String, Int16, String, String)	Adds a new diametric dimension to the current drawing giving the reference arc.
	AddDiametricDimension(Circle, Double, Double, String, Int16, String, String)	Adds a new diametric dimension to the current drawing giving the reference circle.
	AddEllipse	Adds a new ellipse or elliptic arc to the current drawing.
	AddFace3D	Adds a 3D face to the current drawing.
	AddGradientHatch(HatchGradientPatternType, Vector2, Int16, Int16, Double, Boolean, String)	Adds a new gradient hatch to the current drawing giving a point inside.
	AddGradientHatch(HatchGradientPatternType, ListEntityObject, ListEntityObject, Int16, Int16, Double, Boolean, String)	Adds a new gradient hatch to the current drawing.
	AddHatch(HatchPattern, Vector2, Double, Double, Int16, String, String)	Adds a new hatch to the current drawing giving the pattern object.
	AddHatch(String, Vector2, Double, Double, Int16, String, String)	Adds a new hatch to the current drawing giving the pattern name and a point inside.
	AddHatch(HatchPattern, ListEntityObject, ListEntityObject, Double, Double, Int16, String, String)	Adds a new hatch to the current drawing giving the pattern object.
	AddHatch(String, ListEntityObject, ListEntityObject, Double, Double, Int16, String, String)	Adds a new hatch to the current drawing giving the pattern name.
	AddImage	Adds a new image to the current drawing.
	AddInsert	Adds a new insert entity to the current drawing.
	AddLayer	Adds a new layer to the drawing.
	AddLeader	Adds a new leader entity to the current drawing giving two reference points and annotation text.
	AddLightWeightPolyline	Adds a new light weight polyline to the current drawing.
	AddLine(Vector3, Vector3, Int16, String, String)	Adds a new line to the current drawing.
	AddLine(Vector3, Double, Double, Int16, String, String)	Adds a new line to the current drawing using polar coordinates.
	AddLinearDimension(Line, Vector3, Double, String, Int16, String, String)	Adds a new linear dimension to the current drawing giving the reference line.
	AddLinearDimension(Line, Double, Double, String, Int16, String, String)	Adds a new linear dimension to the current drawing giving the reference line.
	AddLinearDimension(Vector3, Vector3, Vector3, Double, String, Int16, String, String)	Adds a new linear dimension to the current drawing with start point and end point.
	AddLinearDimension(Vector3, Vector3, Double, Double, String, Int16, String, String)	Adds a new linear dimension to the current drawing with start point and end point.
	AddMline	Adds a new multiple parallel lines (MLINE) to the current drawing.
	AddOle2Frame	Adds a new image to the current drawing as an embedded ole2frame entity.
	AddPDFUnderlay	Adds a new PDF underlay to the current drawing.
	AddPoint	Adds a new point to the current drawing.
	AddPolygon	Adds a new regular polygon inscribed in a circle to the current drawing with center, radius and rotation.
	AddPolyline	Adds a new polyline to the current drawing.
	AddRadialDimension(Arc, Vector3, String, Int16, String, String)	Adds a new radial dimension to the current drawing giving the reference arc.
	AddRadialDimension(Circle, Vector3, String, Int16, String, String)	Adds a new radial dimension to the current drawing giving the reference circle.
	AddRadialDimension(Arc, Double, Double, String, Int16, String, String)	Adds a new radial dimension to the current drawing giving the reference arc.
	AddRadialDimension(Circle, Double, Double, String, Int16, String, String)	Adds a new radial dimension to the current drawing giving the reference circle.
	AddRay	Adds a new ray to the current drawing.
	AddRectangle	Adds a new lightweight polyline that forms a rectangle.
	AddSolid	Adds a new solid to the current drawing.
	AddSpline	Adds a new spline to the current drawing.
	AddText	Adds a new text to the current drawing.
	AddTextStyle	Adds a new text style to the drawing.
	AddTrace	Adds a new trace to the current drawing using current trace witdh.
	AddView	Adds a new view to the drawing.
	AddViewPort	Adds a new viewport to the drawing.
	AddXLine	Adds a new contruction line to the current drawing.
	ArrayOfEntities(IEnumerableEntityObject, Vector2, Vector2, Int32, Int32)	Creates copies of entities arranged in a regularly spaced rectangular pattern.
	ArrayOfEntities(IEnumerableEntityObject, Vector3, Vector3, Int32, Int32, Int32)	Creates copies of entities arranged in a regularly spaced 3D pattern.
	Chamfer	Chamfers the edges of two objects.
	Clear	Clears graphics in the control.
	ClearDrawnElements	Clears elements added with the Draw methods.
	Contour	Find the contour among a list of entities from an entity of the list.
	CoordsToWorld	Converts pixels coordinates to drawing's coordinates.
	DefaultColorScheme	Use the default color scheme for the control.
	DisplayPredefinedView	Displays the drawing with predefined mode.
	DisplayView	Retreives the drawing view specified by ViewName parameter.
	DrawArc	Draws an arc on the control.
	DrawCircle	Draws a circle on the control.
	DrawEntity	Draws a single entity without refreshing the whole drawing.
	DrawImage(Image, ListEntityObject, ListEntityObject, Int16, Boolean)	Draws an image on the control.
	DrawImage(Image, Vector2, Single, Single, Single, Int16, Boolean)	Draws an image on the control.
	DrawLine	Draws a line on the control.
	DrawPoint	Draws a point on the control.
	DrawPolygon	Draws a polygon on the control.
	DrawText(Pen, String, Vector2, Double, Double, FontStyle, TextAlignment, Boolean)	Draws a text on the control.
	DrawText(Pen, String, Vector2, Double, Double, FontStyle, StringAlignment, Boolean)	Draws a text on the control.
	EntitiesToLwPolylines	Groups a list of Lines, Arcs and polylines into lwpolylines.
	Extend	Extends an entity.
	Fillet	Rounds and fillets the edges of objects.
	GetEntities	Returns a list of entity objects contained in a rectangle.
	GetEntity(Vector2)	Returns the nearest entity to position.
	GetEntity(ListEntityObject, Vector2)	Returns the nearest entity among a list of entities to position.
	HighLight(EntityObject)	Highlights an entity.
	HighLight(ListEntityObject)	Highlights a list of entities.
	Join	Joins two entities.
	LightColorScheme	Use the light color scheme for the control.
	NewDrawing	Creates a new drawing deleting every drawing classes.
	NormalizeEntities	Projects a list of entities on XY plane against normal vector.
	Offset	Offsets an entity.
	Orbit	Orbiting about a direction.
	Pan	Pans the drawing of a distance indicated by the StartPoint-EndPoint segment.
	PixelToWorld	Converts pixels size to drawing's units.
	Plot	Plots the drawing using the default printer.
	PlotPreview	Displays the plot preview on a PrintPreviewControl.
	PolarArrayOfEntities	Creates copies of entities arranged in a regularly spaced circular pattern.
	ReadDXF	Reads and displays the DXF file indicated by the FileName property or by the DXFFileName parameter.
	ReadHatchPatternsFromFile	Returns a list of pattern objects from the definitions in a pat file.
	ReadNC1	Reads a Numerical Control Mastercam File and shows it.
	ReadOBJ	Read a Wavefront .obj file and add its data to the current drawing.
	RecoverDXFFile	Tries to recover a damged DXF file indicated by the DXFFileName parameter.
	RegisterComponent	Displays the Registration Window.
	SetLimits	Sets the drawing limits.
	ShowDimStyles	Shows the default dimension styles dialog for the control.
	ShowDrawingInfo	Shows the default drawing info dialog.
	ShowDrawingInfo(IEnumerableEntityObject)	Shows the default entities info dialog.
	ShowDrawingUnits	Shows the default drawing untis dialog.
	ShowLayers	Shows the default layers dialog for the control.
	ShowPalette	Shows the default Palette dialog for the control.
	ShowProperties(Object)	Shows all properties of a generic object with a modal form.
	ShowProperties(String)	Shows all properties of an object by its handle with a modal form.
	ShowRubberBandAlignedDimension(Line, Vector2, NullableColor, RubberBandType)	Shows the distance specified by referenc line as a rubber band aligned dimension.
	ShowRubberBandAlignedDimension(Vector2, Vector2, Vector2, NullableColor, RubberBandType)	Shows the distance specified by the StartPoint and EndPoint parameters as a rubber band aligned dimension.
	ShowRubberBandAngularDimension	Shows the angle specified by the center point, radius, start angle and end angle parameters af an arc as a rubber band angular dimension.
	ShowRubberBandArc	Shows the arc specified by the center point, radius, start angle and end angle parameters as a rubber band arc.
	ShowRubberBandBox(Vector2, Vector2, NullableColor, RubberBandType)	Shows the rectangle specified by the StartPoint and EndPoint parameters as a rubber band rectangle.
	ShowRubberBandBox(Vector2, Double, Double, NullableColor, RubberBandType)	Shows the rectangle specified by the Position, Width and Height parameters as a rubber band rectangle.
	ShowRubberBandCircle	Shows the circle specified by the CenterPoint and Radius parameters as a rubber band circle.
	ShowRubberBandEntities	Shows the entities specified by Entities parameter as a rubber band group of entities.
	ShowRubberBandLine	Shows the distance specified by the StartPoint and EndPoint parameters as a rubber band line.
	ShowRubberBandLinearDimension(Line, Vector2, Double, NullableColor, RubberBandType)	Shows the distance specified by referenc line as a rubber band linear dimension.
	ShowRubberBandLinearDimension(Vector2, Vector2, Vector2, Double, NullableColor, RubberBandType)	Shows the distance specified by the StartPoint and EndPoint parameters as a rubber band linear dimension.
	ShowRubberBandPolygon	Shows the polygon specified by the Points parameter as a rubber band polygon.
	SplitIntoParts	Generates a list of new DXF documents, each containing individual parts of the specified entities enclosed in closed sections.
	Trim(EntityObject, EntityObject, Vector2)	Trims an entity.
	Trim(ListEntityObject, EntityObject, Vector2)	Trims an entity.
	WorldToCoords	Converts drawing's coordinates to pixels coordinates.
	WriteDXF	Writes the current drawing on a DXF file on disk.
	ZoomCenter	Zooms to the center of display window.
	ZoomExtents	Zooms to the full drawing extents.
	ZoomIn	Zooms in a drawing by scale factor specified in the ZoomInOutPercent property from the center point of the drawing.
	ZoomLimits	Zooms a drawing to the full limits.
	ZoomNext	Zooms to the next view.
	ZoomOut	Zooms out a drawing by scale factor specified in the ZoomInOutPercent property from the center point of the drawing.
	ZoomPrevious	Zooms to the preceding view.
	ZoomSpotIn	Zooms in a drawing by scale factor specified in the ZoomInOutPercent property from the position.
	ZoomSpotOut	Zooms out a drawing by scale factor specified in the ZoomInOutPercent property from the position.
	ZoomWindow	Zooms a drawing to the window specified by the StartPoint and EndPoint parameters.

Top

Events

	Name	Description
	BeforeDrawingChanged	Fired before the drawing is changed.
	DrawingChanged	Fired when the drawing is changed.
	DrawingStatus	Fired when a DXF file is being drawn.
	EndDrawing	Fired when the drawing of a DXF file is ended.
	EndPlot	Fired when the plot of a DXF file is ended.
	EndRead	Fired when the reading of a DXF file is ended.
	EndWrite	Fired when the writing of a DXF file is ended.
	Error	Fired when a non blocking error occurs during operations.
	PlotStatus	Fired when a DXF file is being plot.
	ReadStatus	Fired while a DXF file is being read.
	StartDrawing	Fired when the drawing of a DXF file is started.
	StartPlot	Fired when the plot of a DXF file is started.
	StartRead	Fired when the reading of a DXF file is started.
	StartWrite	Fired when the writing of a DXF file is started.
	WriteStatus	Fired while a DXF file is being written.

Top

Reference

DXFReaderNET Namespace