INameCreationService Interface
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Provides a service that can generate unique names for objects.
public interface class INameCreationServicepublic interface INameCreationServicetype INameCreationService = interfacePublic Interface INameCreationService- Derived
Examples
The following example code provides an example INameCreationService implementation. The service can create a unique name based on a type that does not match any names in the specified container. It can also validate a specified name string.
#using <System.dll>
using namespace System;
using namespace System::ComponentModel::Design;
using namespace System::ComponentModel::Design::Serialization;
using namespace System::Globalization;
namespace NameCreationServiceExample
{
public ref class NameCreationService: public System::ComponentModel::Design::Serialization::INameCreationService
{
public:
NameCreationService(){}
// Creates an identifier for a particular data type that does not conflict
// with the identifiers of any components in the specified collection.
virtual String^ CreateName( System::ComponentModel::IContainer^ container, System::Type^ dataType )
{
// Create a basic type name string.
String^ baseName = dataType->Name;
int uniqueID = 1;
bool unique = false;
// Continue to increment uniqueID numeral until a
// unique ID is located.
while ( !unique )
{
unique = true;
// Check each component in the container for a matching
// base type name and unique ID.
for ( int i = 0; i < container->Components->Count; i++ )
{
// Check component name for match with unique ID string.
if ( container->Components[ i ]->Site->Name->StartsWith( String::Concat( baseName, uniqueID ) ) )
{
// If a match is encountered, set flag to recycle
// collection, increment ID numeral, and restart.
unique = false;
uniqueID++;
break;
}
}
}
return String::Concat( baseName, uniqueID );
}
// Returns whether the specified name contains
// all valid character types.
virtual bool IsValidName( String^ name )
{
for ( int i = 0; i < name->Length; i++ )
{
Char ch = name[ i ];
UnicodeCategory uc = Char::GetUnicodeCategory( ch );
switch ( uc )
{
case UnicodeCategory::UppercaseLetter:
case UnicodeCategory::LowercaseLetter:
case UnicodeCategory::TitlecaseLetter:
case UnicodeCategory::DecimalDigitNumber:
break;
default:
return false;
}
}
return true;
}
// Throws an exception if the specified name does not contain
// all valid character types.
virtual void ValidateName( String^ name )
{
for ( int i = 0; i < name->Length; i++ )
{
Char ch = name[ i ];
UnicodeCategory uc = Char::GetUnicodeCategory( ch );
switch ( uc )
{
case UnicodeCategory::UppercaseLetter:
case UnicodeCategory::LowercaseLetter:
case UnicodeCategory::TitlecaseLetter:
case UnicodeCategory::DecimalDigitNumber:
break;
default:
throw gcnew Exception( String::Format( "The name '{0}' is not a valid identifier.", name ) );
}
}
}
};
}
using System;
using System.ComponentModel.Design;
using System.ComponentModel.Design.Serialization;
using System.Globalization;
namespace NameCreationServiceExample
{
public class NameCreationService : System.ComponentModel.Design.Serialization.INameCreationService
{
public NameCreationService()
{
}
// Creates an identifier for a particular data type that does not conflict
// with the identifiers of any components in the specified collection.
public string CreateName(System.ComponentModel.IContainer container, System.Type dataType)
{
// Create a basic type name string.
string baseName = dataType.Name;
int uniqueID = 1;
bool unique = false;
// Continue to increment uniqueID numeral until a
// unique ID is located.
while( !unique )
{
unique = true;
// Check each component in the container for a matching
// base type name and unique ID.
for(int i=0; i<container.Components.Count; i++)
{
// Check component name for match with unique ID string.
if( container.Components[i].Site.Name.StartsWith(baseName+uniqueID.ToString()) )
{
// If a match is encountered, set flag to recycle
// collection, increment ID numeral, and restart.
unique = false;
uniqueID++;
break;
}
}
}
return baseName+uniqueID.ToString();
}
// Returns whether the specified name contains
// all valid character types.
public bool IsValidName(string name)
{
for(int i = 0; i < name.Length; i++)
{
char ch = name[i];
UnicodeCategory uc = Char.GetUnicodeCategory(ch);
switch (uc)
{
case UnicodeCategory.UppercaseLetter:
case UnicodeCategory.LowercaseLetter:
case UnicodeCategory.TitlecaseLetter:
case UnicodeCategory.DecimalDigitNumber:
break;
default:
return false;
}
}
return true;
}
// Throws an exception if the specified name does not contain
// all valid character types.
public void ValidateName(string name)
{
for(int i = 0; i < name.Length; i++)
{
char ch = name[i];
UnicodeCategory uc = Char.GetUnicodeCategory(ch);
switch (uc)
{
case UnicodeCategory.UppercaseLetter:
case UnicodeCategory.LowercaseLetter:
case UnicodeCategory.TitlecaseLetter:
case UnicodeCategory.DecimalDigitNumber:
break;
default:
throw new Exception("The name '"+name+"' is not a valid identifier.");
}
}
}
}
}
Imports System.ComponentModel.Design
Imports System.ComponentModel.Design.Serialization
Imports System.Globalization
Public Class NameCreationService
Implements System.ComponentModel.Design.Serialization.INameCreationService
Public Sub New()
End Sub
' Creates an identifier for a particular data type that does not conflict
' with the identifiers of any components in the specified collection
Public Function CreateName(ByVal container As System.ComponentModel.IContainer, ByVal dataType As System.Type) As String Implements INameCreationService.CreateName
' Create a basic type name string
Dim baseName As String = dataType.Name
Dim uniqueID As Integer = 1
Dim unique As Boolean = False
' Continue to increment uniqueID numeral until a unique ID is located.
While Not unique
unique = True
' Check each component in the container for a matching
' base type name and unique ID.
Dim i As Integer
For i = 0 To container.Components.Count - 1
' Check component name for match with unique ID string.
If container.Components(i).Site.Name.StartsWith((baseName + uniqueID.ToString())) Then
' If a match is encountered, set flag to recycle
' collection, increment ID numeral, and restart.
unique = False
uniqueID += 1
Exit For
End If
Next i
End While
Return baseName + uniqueID.ToString()
End Function
' Returns whether the specified name contains
' all valid character types.
Public Function IsValidName(ByVal name As String) As Boolean Implements INameCreationService.IsValidName
Dim i As Integer
For i = 0 To name.Length - 1
Dim ch As Char = name.Chars(i)
Dim uc As UnicodeCategory = [Char].GetUnicodeCategory(ch)
Select Case uc
Case UnicodeCategory.UppercaseLetter, UnicodeCategory.LowercaseLetter, UnicodeCategory.TitlecaseLetter, UnicodeCategory.DecimalDigitNumber
Case Else
Return False
End Select
Next i
Return True
End Function
' Throws an exception if the specified name does not contain
' all valid character types.
Public Sub ValidateName(ByVal name As String) Implements INameCreationService.ValidateName
Dim i As Integer
For i = 0 To name.Length - 1
Dim ch As Char = name.Chars(i)
Dim uc As UnicodeCategory = [Char].GetUnicodeCategory(ch)
Select Case uc
Case UnicodeCategory.UppercaseLetter, UnicodeCategory.LowercaseLetter, UnicodeCategory.TitlecaseLetter, UnicodeCategory.DecimalDigitNumber
Case Else
Throw New Exception("The name '" + name + "' is not a valid identifier.")
End Select
Next i
End Sub
End Class
Remarks
A DesignerLoader can implement this service to provide a way for a designer to create new, unique names for objects. If this service is not available, the designer uses a default implementation.
Methods
| CreateName(IContainer, Type) |
Creates a new name that is unique to all components in the specified container. |
| IsValidName(String) |
Gets a value indicating whether the specified name is valid. |
| ValidateName(String) |
Gets a value indicating whether the specified name is valid. |
Applies to
Collaborate with us on GitHub
The source for this content can be found on GitHub, where you can also create and review issues and pull requests. For more information, see our contributor guide.
