CustomProjectPropertyCollection

CustomProjectPropertyCollection class

Represents a collection of custom project properties.

public sealed class CustomProjectPropertyCollection : PropertyKeyedCollection<CustomProjectProperty>

Constructors

NameDescription
CustomProjectPropertyCollection()Initializes a new instance of the CustomProjectPropertyCollection class.

Properties

NameDescription
Count { get; }
override IsReadOnly { get; }Gets a value indicating whether this collection is read-only; otherwise, false.
Item { get; }
Names { get; }

Methods

NameDescription
Add(CustomProjectProperty)
Add(string, bool)Creates a new custom property.
Add(string, DateTime)Creates a new custom property.
Add(string, double)Creates a new custom property.
Add(string, string)Creates a new custom property.
Clear()Clears the PropertyCollection.
Contains(string)
Remove(string)Removes a property with the specified name from the collection.

Examples

Shows how to work with custom project property collections.

var project = new Project(DataDir + "ReadProjectInfo.mpp");

Console.WriteLine("Is custom properties collection read-only?: " + project.CustomProps.IsReadOnly);

// lets add new custom properties
// collection support Boolean, DateTime, Double, String types
project.CustomProps.Add("IsEnterprise", true);
project.CustomProps.Add("Project Start Date", new DateTime(2020, 4, 16, 8, 0, 0));
project.CustomProps.Add("Precision", 10d);
project.CustomProps.Add("Custom Name", "MyProject");

// custom properties are available through the typed collection
Console.WriteLine("Count of custom properties: " + project.CustomProps.Count);
foreach (var property in project.CustomProps)
{
    Console.WriteLine(property.Type);
    Console.WriteLine(property.Name);
    Console.WriteLine(property.Value);
    Console.WriteLine();
}

// get a custom property value
Console.WriteLine("Custom Name: " + project.CustomProps["Custom Name"]);

// iterate over names of custom properties
foreach (var propsName in project.CustomProps.Names)
{
    Console.WriteLine("Name: " + propsName);
    Console.WriteLine();
}

// one can delete a value by string key
if (project.CustomProps.Contains("Custom Name"))
{
    project.CustomProps.Remove("Custom Name");
}

// or one can clear collection completely
project.CustomProps.Clear();

See Also

CustomProjectProperty CustomPropertyType