This documentation is archived and is not being maintained.

IVsaCodeItem Interface

Note: This API is now obsolete.

Represents a code item to be compiled by the script engine.

Namespace:  Microsoft.Vsa
Assembly:  Microsoft.Vsa (in Microsoft.Vsa.dll)

[ObsoleteAttribute("Use of this type is not recommended because it is being deprecated in Visual Studio 2005; there will be no replacement for this feature. Please see the ICodeCompiler documentation for additional help.")]
public interface IVsaCodeItem : IVsaItem

The IVsaCodeItem type exposes the following members.

Public propertyCodeDOMGets the code document object model (CodeDOM) represented in the code item.
Public propertyIsDirtyReturns a value indicating whether the current in-memory representation of the item differs from the persisted representation. (Inherited from IVsaItem.)
Public propertyItemTypeGets the specified object's type, as determined by the IVsaItems.CreateItem Method method. (Inherited from IVsaItem.)
Public propertyNameSets or gets the name of the item. (Inherited from IVsaItem.)
Public propertySourceTextSets or gets the text of a specified code item, including auto-generated code, if any.

Public methodAddEventSourceAdds an event source to the code item. The code item uses the event source to hook up an event to the named event source by calling the IVsaSite.GetEventSourceInstance method, which is implemented by the host.
Public methodAppendSourceTextAppends specified text to the end of the code item.
Public methodGetOptionGets implementation-specific options for a script engine. (Inherited from IVsaItem.)
Public methodRemoveEventSourceRemoves the specified event source from the code item.
Public methodSetOptionSets implementation-specific options for a script engine. (Inherited from IVsaItem.)

The specified code item can contain classes, modules, or other source text.

No permissions are required for calling any members of the IVsaCodeItem interface.

The script engine implements this interface in order to add code items.