PipelineComponentInfo.NoEditor Property
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.
Returns a Boolean that indicates if the Advanced Properties graphical editor is disabled. This field is read-only.
public:
property bool NoEditor { bool get(); };public bool NoEditor { get; }member this.NoEditor : boolPublic ReadOnly Property NoEditor As BooleanProperty Value
Returns a Boolean that indicates if the Advanced Properties graphical editor is disabled. A value of true indicates that the Advanced Properties editor is disabled; otherwise, false. The default is false.
Examples
The following code sample retrieves the information about the pipeline components from the PipelineComponentInfos collection. The sample iterates through the collection, and then prints the values for the properties in each PipelineComponentInfo, including the NoEditorBoolean.
using System;
using System.Collections.Generic;
using System.Text;
using Microsoft.SqlServer.Dts.Runtime;
namespace TaskInfos_Item
{
class Program
{
static void Main(string[] args)
{
Application app = new Application();
PipelineComponentInfos pInfos = app.PipelineComponentInfos;
// Iterate through the collection,
// printing values for the properties.
foreach (PipelineComponentInfo pInfo in pInfos)
{
Console.WriteLine("ComponentType: {0}", pInfo.ComponentType);
Console.WriteLine("CreationName: {0}", pInfo.CreationName);
Console.WriteLine("Description: {0}", pInfo.Description);
Console.WriteLine("FileName: {0}", pInfo.FileName);
//Console.WriteLine("FileNameVersionString: {0}", pInfo.FileNameVersionString);
Console.WriteLine("IconFile: {0}", pInfo.IconFile);
Console.WriteLine("IconResource: {0}", pInfo.IconResource);
Console.WriteLine("ID: {0}", pInfo.ID);
Console.WriteLine("Name: {0}", pInfo.Name);
Console.WriteLine("NoEditor: {0}", pInfo.NoEditor);
Console.WriteLine("ShapeProgID: {0}", pInfo.ShapeProgID);
Console.WriteLine("UITypeName: {0}", pInfo.UITypeName);
Console.WriteLine("--------------------------------------");
}
}
}
}
Imports System
Imports System.Collections.Generic
Imports System.Text
Imports Microsoft.SqlServer.Dts.Runtime
Namespace TaskInfos_Item
Class Program
Shared Sub Main(ByVal args() As String)
Dim app As Application = New Application()
Dim pInfos As PipelineComponentInfos = app.PipelineComponentInfos
' Iterate through the collection,
' printing values for the properties.
Dim pInfo As PipelineComponentInfo
For Each pInfo In pInfos
Console.WriteLine("ComponentType: {0}", pInfo.ComponentType)
Console.WriteLine("CreationName: {0}", pInfo.CreationName)
Console.WriteLine("Description: {0}", pInfo.Description)
Console.WriteLine("FileName: {0}", pInfo.FileName)
'Console.WriteLine("FileNameVersionString: {0}", pInfo.FileNameVersionString)
Console.WriteLine("IconFile: {0}", pInfo.IconFile)
Console.WriteLine("IconResource: {0}", pInfo.IconResource)
Console.WriteLine("ID: {0}", pInfo.ID)
Console.WriteLine("Name: {0}", pInfo.Name)
Console.WriteLine("NoEditor: {0}", pInfo.NoEditor)
Console.WriteLine("ShapeProgID: {0}", pInfo.ShapeProgID)
Console.WriteLine("UITypeName: {0}", pInfo.UITypeName)
Console.WriteLine("--------------------------------------")
Next
End Sub
End Class
Sample Output:
ComponentType: Transform
CreationName: DTSTransform.Merge.1
Description: Merge Transformation
FileName: C:\Program Files\Microsoft SQL Server\100\DTS\PipelineComponents\TxMerge.dll
IconFile: C:\Program Files\Microsoft SQL Server\100\DTS\PipelineComponents\TxMerge.dll
IconResource: -201
ID: {08AE886A-4124-499C-B332-16E3299D225A}
Name: Merge
NoEditor: False
ShapeProgID:
UITypeName: Microsoft.DataTransformationServices.DataFlowUI.MergeUI, Microsoft.DatatransformationServices.DataFlowUI, Version=10.0.000.0, Culture=neutral, PublicKeyToken=89845dcd8080cc91
--------------------------------------
ComponentType: Transform
CreationName: DTSTransform.MergeJoin.1
Description: Merge Join Transformation
FileName: C:\Program Files\Microsoft SQL Server\100\DTS\PipelineComponents\TxMergeJoin.dll
IconFile: C:\Program Files\Microsoft SQL Server\100\DTS\PipelineComponents\TxMergeJoin.dll
IconResource: -201
ID: {0D598A60-0A32-4B1B-A72C-5030B64E3A20}
Name: Merge Join
NoEditor: False
ShapeProgID:
UITypeName: Microsoft.DataTransformationServices.Design.DtsMergeJoinComponentUI, Microsoft.DatatransformationServices.DataFlowUI, Version=10.0.000.0, Culture=neutral, PublicKeyToken=89845dcd8080cc91
--------------------------------------
Remarks
The Advanced Properties editor is the generic editor available to all data flow components. Set this property to true to prevent the Advanced Properties editor from being available to users of your component.
If this property is false, and the UITypeName property is not specified, the only technique available for editing the component is the Properties window.