DtsLogProviderAttribute.IconResource Property

Definition

Namespace:

Microsoft.SqlServer.Dts.Runtime

Assembly:

Microsoft.SqlServer.ManagedDTS.dll

Gets or sets the icon associated with a log provider.

public:
 property System::String ^ IconResource { System::String ^ get(); void set(System::String ^ value); };

public string IconResource { get; set; }

member this.IconResource : string with get, set

Public Property IconResource As String

Property Value

String

A string that identifies the icon resource of the log provider.

Examples

The following example shows a log provider class that provides an icon resource. In this example, the icon file is named MyLogProviderIcon.ico, and the assembly name is MyLogProvider.

using System;  
using Microsoft.SqlServer.Dts.Runtime;  

namespace Microsoft.Samples.SqlServer.Dts  
{  
[DtsLogProvider(LogProviderType = "MyLOG",   
  DisplayName = "MyCustomLogProvider ",   
  Description = "Custom Log Provider")]  
public class MyCustomLogProvider : LogProviderBase  
{  
    // Your custom log provider code here.  
}  
}  

Imports System  
Imports Microsoft.SqlServer.Dts.Runtime  

<DtsLogProvider(LogProviderType:="MyLOG", _  
DisplayName:="MyCustomLogProvider ", _  
Description:="Custom Log Provider")> _  
Public Class MyCustomLogProvider  
  Inherits LogProviderBase  
  ' Your custom log provider code here.  
End Class  

Remarks

When specified, this property identifies the icon shown in the SQL Server Data Tools (SSDT) when the log provider is displayed.

The string should contain the name of the assembly and the name of the icon file. To embed an icon file as a resource in an assembly using Visual Studio .NET, set the icon's Build Action attribute to Embedded Resource.