CustomProjectItemContainer<T> Class

In This Topic

A custom project item container contains custom project items of a specific type that have been added to a project.

Syntax

C#
Visual Basic (Declaration)

public abstract class CustomProjectItemContainer<T> : ArcGIS.Desktop.Internal.Core.ProjectItemContainer<T>, IMetadata, ISearchableItem, System.Collections.Generic.IEnumerable<T>, System.Collections.Generic.IReadOnlyCollection<T>, System.Collections.Generic.IReadOnlyList<T>, System.Collections.IEnumerable, System.ComponentModel.INotifyPropertyChanged, System.IDisposable  
where T: CustomProjectItemBase

Public MustInherit Class CustomProjectItemContainer(Of T As CustomProjectItemBase) 
   Inherits ArcGIS.Desktop.Internal.Core.ProjectItemContainer(Of T)
   Implements IMetadata, ISearchableItem, System.Collections.Generic.IEnumerable(Of T), System.Collections.Generic.IReadOnlyCollection(Of T), System.Collections.Generic.IReadOnlyList(Of T), System.Collections.IEnumerable, System.ComponentModel.INotifyPropertyChanged, System.IDisposable

Type Parameters

T: The type of custom project item the container will contain

Remarks

By default, empty project item containers are not visible in the Catalog pane or view. They only become visible once they contain at least one (custom) project item. Custom project item containers are registered in the Config.daml within the esri_core_projectContainers category. Custom project item containers have an associated "container type" which is an arbitrary unique string used to identify your container within the project container collection.
Custom project items must know their corresponding custom project item container container type.

Example

//Add an item to the project...
//This will automatically show the item's container if it is not already visible
QueuedTask.Run(() => Project.Current.AddItem(my_custom_project_item));
            
//To retrieve the given custom project item container itself...
var containerType = "MyCustomContainer";
var container = Project.Current.GetProjectItemContainer(containerType) as MyProjectItemContainer;
...etc.

Inheritance Hierarchy

System.Object
   ArcGIS.Desktop.Framework.Contracts.PropertyChangedBase
      ArcGIS.Desktop.Core.Item
            ArcGIS.Desktop.Core.CustomProjectItemContainer<T>

Requirements

Target Platforms: Windows 11, Windows 10

ArcGIS Pro version: 3.0 or higher.

Reference

CustomProjectItemContainer<T> Members
ArcGIS.Desktop.Core Namespace

Send feedback