Edit

ICustomTaskPaneConsumer.CTPFactoryAvailable method (Office)

  • Article

Passes an ICTPFactory object to a Microsoft ActiveX add-in that can then be used when creating a custom task pane.

Syntax

expression.CTPFactoryAvailable (CTPFactoryInst)

expression An expression that returns an ICustomTaskPaneConsumer object.

Parameters

Name Required/Optional Data type Description
CTPFactoryInst Required ICTPFactory The object is used by an add-in to create a task pane.

Example

The following example, written in C#, creates an instance of a CustomTaskPane object through the ICustomTaskPaneConsumer interface and implements its only method, CTPFactoryAvailable. CTPFactoryAvailable passes an ICTPFactory object to the add-in, which you can use during the add-in's lifetime to create a task pane by using the CreateCTP method.

Note that the example assumes that the task pane is part of a COM add-in and thus implements Extensibility.IDTExtensibility2. The add-in also refers to an ActiveX control, SampleActiveX.myControl, which was created in a separate project.

public class Connect : Object, Extensibility.IDTExtensibility2, ICustomTaskPaneConsumer 
... 
object missing = Type.Missing; 
public CustomTaskPane CTP = null; 
 
public void CTPFactoryAvailable(ICTPFactory CTPFactoryInst) 
{ 
 CTP = CTPFactoryInst.CreateCTP("SampleActiveX.myControl", "Task Pane Example", missing); 
 sampleAX = (myControl)CTP.ContentControl; 
 sampleAX.InsertTextClicked += new InsertTextEventHandler(sampleAX_InsertTextClicked); 
 CTP.Visible = true; 
}

Note

You can create custom task panes in any language that supports COM and allows you to create dynamic-linked library (DLL) files; for example, Microsoft Visual Basic 6.0, Visual Basic .NET, Visual C++, Visual C++ .NET, and Visual C#. However, Visual Basic for Applications (VBA) does not support creating custom task panes.

See also

Support and feedback

Have questions or feedback about Office VBA or this documentation? Please see Office VBA support and feedback for guidance about the ways you can receive support and provide feedback.