Labels Property

Summary

Gets the collection of labels to render on top of this AnnContainer.

Syntax

Objective-C

C++

Java

public IList<AnnLabel> Labels { get; }

Public ReadOnly Property Labels As IList(Of AnnLabel)

@property (nonatomic,readonly) NSMutableArray* labels;

public List<AnnLabel> getLabels()

public:  
   property IList<AnnLabel^>^ Labels 
   { 
      IList<AnnLabel^>^ get() 
   }

Property Value

A collection of AnnLabels to render on top of this AnnContainer.

Remarks

The labels will be rendered using the global AnnRenderingEngine.ContainerLabelRenderer object. This object is automatically created by the annotation framework and can be usable right away.

The container labels can be used to place text items on top of the container that are not part of the annotations objects. For example, to place legends in a mapping application.

Example

using LeadtoolsExamples.Common; 
using Leadtools.Annotations.Automation; 
using Leadtools.Annotations.Engine; 
using Leadtools.Codecs; 
using Leadtools.Annotations.WinForms; 
 
public void AnnContainer_Labels() 
{ 
   // Get the container for this automation 
   AnnContainer container = _automation.Container; 
 
   double inch = 720.0; 
 
   // Create a couple of labels 
   AnnLabel label = new AnnLabel(); 
   label.IsVisible = true; 
   label.OriginalPosition = LeadPointD.Create(1 * inch, 1 * inch); 
   label.Foreground = AnnSolidColorBrush.Create("Red"); 
   label.Background = AnnSolidColorBrush.Create("rgba(0, 0, 0, 0.5)"); 
   label.Text = "Red Label"; 
   container.Labels.Add(label); 
 
   label = new AnnLabel(); 
   label.IsVisible = true; 
   label.OriginalPosition = LeadPointD.Create(4 * inch, 4 * inch); 
   label.Foreground = AnnSolidColorBrush.Create("Blue"); 
   label.Background = AnnSolidColorBrush.Create("rgba(0, 0, 0, 0.5)"); 
   label.Text = "Blue Label"; 
   container.Labels.Add(label); 
 
   // Show the labels 
   _automation.Invalidate(LeadRectD.Empty); 
}

Requirements

Target Platforms

Reference

AnnContainer Class

AnnContainer Members

Download our FREE evaluation

Help Version 20.0.2020.3.31

Leadtools.Annotations.Engine Assembly

Introduction

Getting Started

Namespaces

Leadtools.Annotations.Engine Namespace

Assemblies