ProvideToolboxFormatAttribute.Format Property

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell

Assembly:: Microsoft.VisualStudio.Shell.14.0.dll

Assembly:: Microsoft.VisualStudio.Shell.15.0.dll

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.

Gets the name of a supported clipboard format.

public:
 property System::String ^ Format { System::String ^ get(); };

public:
 property Platform::String ^ Format { Platform::String ^ get(); };

public string Format { get; }

member this.Format : string

Public ReadOnly Property Format As String

Property Value

String

The name of the clipboard format.

Examples

In the example below, a list of the ProvideToolboxFormatAttribute attributes applied to the VSPackage is obtained and the format values are written to standard output.

public  void PrintFormats(RegistrationContext context) {  
    foreach(ProvideToolboxFormatAttribute pfa in   
            context.ComponentType.GetCustomAttributes(typeof(ProvideToolboxFormatAttribute), true)) {  
                if (format.Length != 0) {  
                    System.Console.WriteLine(pfa.Format);  
                   }  
     }

}

Remarks

This property is set in the constructor. It must be applied together with the ProvideToolboxItemsAttribute attribute to register a VSPackage's support for specific clipboard formats.

Applies to