DicomObjects.NET.V8
DicomObjects Namespace / DicomLabel Class
Properties Methods Events

In This Topic
    DicomLabel Class Members
    In This Topic

    The following tables list the members exposed by DicomLabel.

    Public Constructors
     NameDescription
    Public ConstructorCreates a new blank DicomLabel object  
    Top
    Public Properties
     NameDescription
    Public PropertyA pair of coordinates (x, y) of an visible anchor point for a text label  
    Public PropertyDefines how anchor point is transformed with the image  
    Public PropertyAngle to rotate Label (Clockwise)  
    Public PropertyThe 4 edges of the rectangle area of the DicomLabel  
    Public Property Controls the size of a text label.  
    Public Property Area that encloses the label as displayed  
    Public Property Objects used to fill the interiors of graphical shapes such as rectangles, ellipses, pies, polygons, and paths  
    Public Property Specify the locations of the child labels  
    Public Property A DicomLabel collection linked with the primary DicomLabel. Useful for grouping labels together so you can do one operation for all of them, i.e movement.  
    Public PropertyDraw a circle using Perpendicular Bisector from the first three user defined Points. For this to work you need to select the DicomObjects.Enums.LabelType.Ellipse and set at least three Points Default is false, which means the label will use Area property instead of user defined points  
    Public PropertyThe Font to be used for text labels  
    Public PropertySpecify which Font in the Fonts Collection to apply to the Current DicomLabel object.  
    Public Propertystatic (Shared in Visual Basic)A Static Font collection. Users can define and add their list of fonts and choose which to apply to each DicomLabel object using DicomLabel's FontIndex property.  
    Public Property List of Frames you want to display the DicomLabel on. Empty FrameList is default value and it means display on all frames.  
    Public PropertyDefine the height of a DicomLabel (annotation) on an image  
    Public PropertyThe Image to be displayed by an Image type DicomLabel  
    Public PropertyControls the opacity of the Image label. Only applicable to DicomObjects.Enums.LabelType.Image.

    Value ranges from 0-1 (None to Full opacity)

     
    Public Propertystatic (Shared in Visual Basic) The type of label created by DicomObjects from Presentation states  
    Public PropertyThis property controls whether the DicomLabel goes into the PresentationState or not when one of the CurrentToPresentationState methods is used.  
    Public PropertySpecify if the DicomLabel is Interpolated  
    Public Property This property decides whether or not the DicomLabel will be acting as a Shutter.  
    Public PropertyDetermines the basic type of a label  
    Public PropertyDefine the left of a DicomLabel (annotation) on an image  
    Public PropertyDefines a margin between text and it’s bounding box  
    Public Property Specify the minimum Arrow size when the labeltype is set to LabelArrow  
    Public PropertyObject used to draw lines and curves  
    Public Property The plane on which this label will be displayed when used on a 3D image  
    Public PropertyThe points of a DicomLabel (of type PolyLine or Polygon)  
    Public Property The image whose plane is used to control the placement of this image, as a line.  
    Public PropertyControls whether the label is drawn in reversible mode  
    Public Property Controls the centre of rotation of a text label.  
    Public Property Controls the rotation behaviour of a label.  
    Public PropertyDefines the centre point used for label rotation (whether due to Angle or as a result of RotationMode) if the RotationCentre is set to SpecifiedPoint  
    Public PropertyRuler options used if LabelType is set to Ruler  
    Public Property Controls the approximate spacing of the minor ticks for a ruler label  
    Public PropertyDetermines whether the font size scales with the image  
    Public PropertyDefines a basic scale mode of DicomLabel  
    Public Property Control whether the width of a line scales with the label being drawn  
    Public PropertyControls whether a label is highlighted using a box and/or “handles”  
    Public PropertySelect Pen from Pen  
    Public Property Controls whether a label is displayed with a contrasting shadow, to make it more visible over image areas with the same colour.  
    Public PropertyContains the colour of the Shadow applied to the DicomLabel  
    Public PropertyDetermines whether the anchor point is shown  
    Public PropertyControls whether text boxes have a visible border  
    Public PropertyHandles text alignment using the .NET StringFormat Member  
    Public PropertyA general purpose Tag for developer use  
    Public PropertyThe text to be displayed by a text type DicomLabel  
    Public PropertyThe brush object only for labels of type "doLabelText"  
    Public Property Control text label anti-aliasing behaviour  
    Public PropertyDefine the top of a DicomLabel (annotation) on an image  
    Public PropertyControls whether a DicomLabel object is displayed  
    Public PropertyDefine the width of a DicomLabel (annotation) on an image  
    Top
    Public Methods
     NameDescription
    Public MethodOverloaded.  Adds to point to the path used for a polyline or polygon type of DicomLabel  
    Public Method Move or resize a label defined offset where the offset is defined in screen pixel units  
    Public MethodLimits a line to the section within a given rectangle  
    Public MethodClones the DicomLabel  
    Public Methodstatic (Shared in Visual Basic) Create 3D label  
    Public MethodReturns the size of the spacing used in a DicomLabel of type Ruler  
    Public MethodProvides the Matrix object used to display the DicomLabel  
    Public MethodAllows control of Export of objects derived from a DicomLabel  
    Public MethodAllows control of Import of objects derived from a DicomLabel  
    Public MethodOverloaded. Transform a label from viewer coordinates to the chosen image scaling type  
    Public MethodOverloaded. Returns the area of the ROI  
    Public MethodOverloaded. Distance units for the values returned by ROILength and ROIArea of a None-Image-Tied label  
    Public MethodOverloaded.  Length of the boundary of a DicomLabel, interpreted as a region of interest. The overload method applies to None-Image-Tied labels  
    Public MethodReturns the maximum values of the pixels in the ROI  
    Public MethodReturns the mean value of the pixels in the ROI  
    Public MethodReturns the minimum values of the pixels in the ROI  
    Public MethodThe list of points within the label  
    Public MethodReturns the standard deviation of the values of the pixels in the ROI  
    Public MethodThe values within a DicomLabel, interpreted as a region of interest  
    Public Method Returns the line angle of the DicomLabel. Image Pixel Aspect Ratio is automatically taken into account.  
    Public MethodMakes a bitmap label by thresholding an existing label  
    Public MethodAdjusts the position, size etc. of the label  
    Public MethodForce display update for this label  
    Top
    Public Events
     NameDescription
    Public EventEvent fired when the properties of a label are changed.  
    Public Event Event fires when a new DicomLabel is created when a Presentation State is applied to an image. This event gives users a chance to customise the label before display  
    Top
    See Also