gmslAPI  0.1
gmslAPI: An API for Developing Upgrade Solutions using Great Migrations Technology
gmslLibrary.Model.tVbControl Class Reference

The tVbControl class controls the content of user defined control description blocks retrieved from a VBI file which specify the content of controls within the various types of VB6 form files, designer files, document files, and user control files. They do not have values and therefore are children of the tMigInfo class. More...

Inheritance diagram for gmslLibrary.Model.tVbControl:
gmslLibrary.Model.tMigInfo

Public Member Functions

 tVbControl (int iRoot, bool delta=false)
 The tVbControl constructor obtains a handle to a user control component in the current information storage area which can the used to get and or set the properties of that component. The handle itself is only locally defined and should not be used in extended contexts. More...
 
- Public Member Functions inherited from gmslLibrary.Model.tMigInfo
 tMigInfo (int iRoot, bool delta=false)
 The tMigInfo constructor obtains a handle to a migratable component in the information storage area which can the used to get and or set the properties of that component. The handle itself is only locally defined and should not be used in extended contexts. More...
 
 tMigInfo (int iRoot)
 
int SetContextFlags ()
 The SetContextFlags merges the context flags associated with the current migration component with the global project flags. More...
 

Properties

int formFile [get, set]
 The integer property formFile contains the root offset of the code form file that contains the control. More...
 
int userClass [get, set]
 The integer property userClass specifies the class type code of the control. More...
 
int ctlType [get, set]
 The integer property ctlType specifies the control type code of the control. More...
 
int iVector [get, set]
 The integer property iVector is used to control the processing of the members of the control when it is an array. It typically contains the sequence number of the current control array member being processed. More...
 
int nVector [get, set]
 If not zero, the integer property nVector specifies that the control ia an array. It specifies the number of members in the array. More...
 
int nxtVector [get, set]
 The integer property nxtVector is used to control the processing of the members of the control when it is an array. It typically contains the sequence number of the next control array member to be processed. More...
 
int cmpCodeStart [get, set]
 The integer property cmpCodeStart is the offset of the code block that contains the property bag value assignments for the control properties as produced by the compiler. More...
 
int anaCodeStart [get, set]
 The integer property anaCodeStart is the offset of the code block that contains the property bag value assignments for the control properties after it has been analysed and transformed. It is this code block that is used to author the declaration of the control. More...
 
- Properties inherited from gmslLibrary.Model.tMigInfo
int migTransform [get, set]
 The integer migTransform property is used to trigger transformation methods during a code scan. It is set equal to a migration dll number times 256 plus a migration specific transformation number. More...
 
int migRuntime [get, set]
 The integer migRuntime property is used to contain migration specific runtime values as needed. More...
 
int migFlags [get, set]
 The integer migFlags property contains migration flags. It is deprecated and is present only for compatiblity with the scripting language supported by the tool which uses binary bit masks to set and get boolean properties. More...
 
int migStatus [get, set]
 The integer migStatus property contains migration status flags. It is deprecated and is present only for compatiblity with the scripting language supported by the tool which uses binary bit masks to set and get boolean properties. More...
 
int migStatus2 [get, set]
 The integer migStatus2 property contains additional migration flags. It is deprecated and is present only for compatiblity with the scripting language supported by the tool which uses binary bit masks to set and get boolean properties. More...
 
int context [get, set]
 The integer context property contains component context use flags. It is deprecated and is present only for compatiblity with the scripting language supported by the tool which uses binary bit masks to set and get boolean properties. More...
 
int migPattern [get, set]
 The integer migPattern property contains the offset of any surface pattern that has been posted the the component. It is zero if no has been posted. More...
 
string migComment [get, set]
 The string property migComment contains any comment that was associated with the component. This might be from an inline comment in the source code or may be set by the tool. More...
 
int CommentValue [get, set]
 
bool NotImplemented [get, set]
 The bool property NotImplemented specifies that the component has no implementation in the target. References to it are commented out and adorned in the translated code. More...
 
bool Delete [get, set]
 The bool property Delete specifies that component should be deleted from the target. References to it are literally removed from the target code. More...
 
bool CanBeNUll [get, set]
 The bool property CanBeNull specifies that the component itself, or its instances, are being checked for being empty. These instances can be Null as well. References to them in the intermediate code have to be checked if they are they are Null or Empty. More...
 
bool UserCode [get, set]
 The bool property UserCode specifies that there may be runtime gmNI user code for processing this component. The identifier of this component, that triggers the event handler code, is specified for the component in its comment property. More...
 
bool External [get, set]
 The bool property External specifies that the component is external to the parent in the target implementation to which it was assigned in the source implementation. Therefore, when authoring the identifier of the component do not precede it with its source parent membership information. More...
 
bool NeedsInit [get, set]
 The bool property NeedsInit specifies whether the component needs to be initialized by the author in the target code. For control arrays, when the analyser detects an explicit reference to the control array in any subprogram code, it sets this property for the control More...
 
bool HasMigclass [get, set]
 The bool property HasMigclass specifies that there is a user-defined or library-defined migClass that controls some aspect of the component. More...
 
bool LocalLibrary [get, set]
 The bool property LocalLibrary specifies that the library was formed as via a translation of a VB6 project within the migration set as opposed to being formed directly from an IDL file. More...
 
bool Remove [get, set]
 The bool property Remove specifies that references to the component should be removed as opposed to deleting any statements that reference the component. This is used primarily for subprograms and subprogram arguments. More...
 
bool Nullable [get, set]
 The bool property Nullable specifies that the type of the component is "Nullable". A nullable type can represent the correct range of values for its underlying value type, plus an additional null value. The type of the component is adorned with a "?" suffix in the target code. More...
 
bool AddArgument [get, set]
 The bool property AddArgument is used with subprograms. It indicates that an argument should be added to the argument list in the target translation. More...
 
bool CallPattern [get, set]
 The bool property CallPattern specifies that the surface form pattern associated with the component should be used when it is referenced, not when it is translated. More...
 
bool Overrideuser [get, set]
 The bool property Overrideuser appies to components that are used to satisfy Implementation requirements, this property forces the component to have the attributes as specified in the interface as opposed to as specified in the user code. When applied to classes whose identifiers match those of control classes within the internal VB6 language description, this property indicates that the internal description should be overridden. More...
 
bool SkipDecl [get, set]
 The bool property SkipDecl is set by the analyser to mark property setters and/or getters that can be skipped. More...
 
bool MigStatic [get, set]
 The bool property MigStatic specifies that the component is static in the target implementation and thus any New creations must be removed. More...
 
bool IsDbNull [get, set]
 The bool property IsDbNull specifies that the component is a class whose instances should be checked against DbNull as opposed to Null. More...
 
bool MustCorrect [get, set]
 The bool property NustCorrect specifies that the component must be corrected in the target. References to it are commented out and adorned accordingly. More...
 
bool Noncreatable [get, set]
 The bool property Noncreatable specifies that the component class instances cannot be created. When declaring objects of this class simply set them to "null" as opposed to using new to create an instance. More...
 
bool SingletonRef [get, set]
 The bool property SingletonRef specifies that the library component has been referenced as a singleton, without any class or parent designation. This may be an incorrect reference that has to be repaired. More...
 
bool StubOut [get, set]
 The bool property StubOut specifies that any code associated with the component should be ignored but a stub for the component should still be declared. More...
 
bool Override [get, set]
 The bool property Override specifies that the subprogram component requires the Override specification when it is declared. More...
 
bool CastType [get, set]
 The bool property CastType specifies that the component does not require type casts when setting its values. More...
 
bool Referenced [get, set]
 The bool property Referenced is used by the author to mark those components that are actually referenced and that need to be included when authoring a wrapper. More...
 
bool SingletonUsed [get, set]
 The bool property SingletonUsed specifies that the library component has been used as a singleton, without any class or parent designation. This usage may be incorrect and in need of repair. More...
 
bool AppObject [get, set]
 The bool property AppObject specifies that the component is an application wide singleton object which requires that special AppObject code be authored for it. More...
 
bool ArrayArray [get, set]
 The bool property ArrayArray specifies that the component is two-dimensional but should be authored as a array of arrays – e.g. [][] – as opposed to [,]. More...
 
bool Module [get, set]
 The bool property Module specifies that the interface component is a module as opposed to a class, so its members may be referenced as singletons. More...
 
bool Implemented [get, set]
 The bool property Implemented specifies that the class or interface component is implemented by another class in the current migration group. More...
 
bool ActiveX [get, set]
 The bool property ActiveX indicates that the coclass component is a control which can appear on a form; consequently there are special "Ax" naming conventions that must be used. More...
 
bool UsesCOM [get, set]
 The bool property UsesCOM specifies that the component should be treated as though it were an ActiveX control. More...
 
bool BoxTypes [get, set]
 The bool property BoxTypes is used by the compiler when it encounters a potential late binding to this component. It checks if that late binding could be resolved if the reference were boxed to one of several types. If so do it, if not do the late binding. More...
 
bool DesignerFile [get, set]
 The bool property DesignerFile specifies that the source of a form file was a "Dsr" file. More...
 
bool HasMdiParent [get, set]
 The bool property HasMdiParent specifies that the parent of a control is an MDI form. More...
 
bool HasFixedArray [get, set]
 The bool property HasFixedArray specifies that a UDT (User Defined Type) contains a fixed array which requires special authoring rules. More...
 
bool ControlArrayIndex [get, set]
 The bool property ControlArrayIndex specifies that a parameter for a control array handler is in fact the index for the array even when its identifier is not "index". More...
 
bool NeedsSetterWrap [get, set]
 The bool property NeedsSetterWrap specifies that a property has a getter, but no setter even though the code has sets that refer to it. More...
 
bool InternalOnly [get, set]
 The bool property InternalOnly marks a subprogram as being an internally defined Enumerator. More...
 
bool FunctionVariable [get, set]
 The bool property FunctionVariable specifies that the trarget translation of a function method does not require the declaration of an internal variable to hold the functional value. More...
 
bool DoNotInitialize [get, set]
 The bool property DoNotInitialize specifies that the declaration of a component should not include any initialization values. More...
 
bool DoNotOverload [get, set]
 The bool property DoNotOverload specifies that a subprogram should not have any overloads authored. More...
 
bool HasSpecialArgs [get, set]
 The bool property HasSpecialArgs specifies that a subprogram had special generic parameters. More...
 
bool HasExtensions [get, set]
 The bool property HasExtensions specifies that a method has Extension methods defined for it. More...
 
bool InterfaceOnly [get, set]
 The bool property InterfaceOnly specifies that no implementation code should be authored for a method. it is used on VB6 class information structure. It is computed while the individual members of the interface are being authored. More...
 
bool GenericCollection [get, set]
 The bool property GenericCollection specifies that a particular collection class is to be authored using generic conventions. More...
 
bool PassValueOnCall [get, set]
 The bool property PassValueOnCall specifies that references to the component should be passsed by value. More...
 
bool Inferred [get, set]
 The bool property Inferred specifies that the binary type of the component has been inferred by the analyser. More...
 
bool HasAddedMembers [get, set]
 The bool property HasAddedMembers indicates that a library component has added members via a migClass declartion. More...
 
bool RemoveGoSub [get, set]
 The bool property RemoveGoSub specifies that the method should not be analysed for possible GoSub removal. More...
 
bool UseEventClass [get, set]
 The bool property UseEventClass specifies that a referenced event had no handlers defined but there are down stream handlers. In this case the translation of the reference code event has to be refactored. More...
 
bool ControlCollection [get, set]
 The bool property ControlCollection indicates that a parameter that has been inferred to be a simple control is in fact a control collection. More...
 
bool HasClassName [get, set]
 The bool property HasClassName is used in situations where both the class name and the field name exist at the same scope level in the VB6. The particular problem is that in the tool's processing the class name is recognized and not the field. The class name is sent on to an IDF and may well be referenced by other codes; while the module field is local to this code The solution does two things: first, it changes the name of the module field and second it recognizes that field identifier in value references and the class identifier in type references. More...
 
bool CouldBeByRef [get, set]
 The bool property CouldBeByRef specifies that a subprogram argument was not explicitly defined as being "ByVal" and therefore could be ByRef. THis is a hint used in the analyser which attempts to minimize ByRef parameters. More...
 
bool IsArray [get, set]
 The bool property IsArray specifies that a component has been reference via the IsArray() method. This is used to add in determining whether the component has to be declared as an object. More...
 
bool IsIndexed [get, set]
 The bool property IsIndexed indicates that a component has been explicitly indexed in the source code. More...
 
bool INCLUDE [get, set]
 The bool property INCLUDE indicates that the ASP page is an include file of some sort. More...
 
bool EXPLICIT [get, set]
 The bool property EXPLICIT indicates that the ASP page had code with Option explicit set. More...
 
bool VBNETLIB [get, set]
 The bool property VBNETLIB indicates that the ASP page contains code that references methofs in the VBNET namespace. More...
 
bool CODEBEHIND [get, set]
 The bool property CODEBEHIND indicates that the ASP page had code that has been moved to a code file. More...
 
bool NOMARKUP [get, set]
 The bool property NOMARKUP indicates that the ASP page does not have markup code. More...
 
bool CROSSREF [get, set]
 The bool property CROSSREF indicates that the ASP page has cross references with other pages. More...
 
bool BACKREF [get, set]
 The bool property BACKREF is deprecated. It indicates that the ASP page had backward references. More...
 
bool GLOBAL [get, set]
 The bool property GLOBAL indicates that the ASP page is an ASA page with global symbols. More...
 
bool PAGELOAD [get, set]
 The bool property PAGELOAD indicates that the ASP page requires that a Page_Load method be written. More...
 
bool HASSTATE [get, set]
 The bool property HASSTATE indicates that the ASP page has a state that will have to be maintained. More...
 
bool NESTEDINC [get, set]
 The bool property NESTEDINC indicates that the ASP page is a nested include. More...
 
bool HASMARKUP [get, set]
 The bool property indicates that the ASP page has markup code. More...
 
bool USERCONTROL [get, set]
 The bool property USERCONTROL indicates that the ASP page is to be treated as a user control. More...
 
bool AUTHORMARKUP [get, set]
 The bool property AUTHOMARKUP indicates that the ASP code class has markup code. More...
 
bool GLOBALINCLUDE [get, set]
 The bool property GLOBALINCLUDE indicates that the ASP page is to be treated as a global include. More...
 
bool EXTENSIONS [get, set]
 The bool property EXTENSIONS indicates that the ASP page has extensions. More...
 
bool Private [get, set]
 The bool Private property specifies that the component is declared as being private to the parent that contains it. This may because of an explicit declaration or it may be a status added to the component for some reason. More...
 
bool Public [get, set]
 The bool Public property specifies that the component is declared as being public. This normally means that it may be referenced anywhere in the code. More...
 
bool Static [get, set]
 The bool Static property specifies that the component is declared as being static. This normally means that its parent keeps only one parent-wide value for the component as opposed to allocating a new value each time a parent object is created. More...
 
bool WithEvents [get, set]
 The bool WithEvents property specifies that the component was declared as being "WithEvents". Which means that events can occur for the object for which event handlers might be present in the source code. More...
 
bool Argument [get, set]
 The bool Argument property specifies that the component is an argument of a subprogram or method or accessor or event. More...
 
bool ByVal [get, set]
 The bool ByVal property specifies that the component is a parameter whose arguments will be pased by value. More...
 
bool ByRef [get, set]
 The bool ByRef property specifies that the component is a parameter whose arguments will be passed by reference. More...
 
bool Foreign [get, set]
 The bool Foreign property specifies that the component was referenced in a comprehensible way, but no definition of it could be found in either the user code or the libraries being referenced. More...
 
bool DeadCode [get, set]
 The bool DeadCode property specifies that the component has been marked as being dead code. This means that its declaration will be skipped. This setting has no effect on references to the component. See the Migration status flags for more information on dead component references. More...
 
bool UseGet [get, set]
 The bool UseGet property specifies that the component requires the use of a "getter" to access its value. More...
 
bool ByOut [get, set]
 The bool ByOut property specifies that the component is an parameter whose argument values will be stored in the calling reference location when its subprogram exits. More...
 
bool Optional [get, set]
 The bool Optional property specifies that the component is a parameter whose arguments may be optionally omitted when its subprogram is called. More...
 
bool NotDeclared [get, set]
 The bool NotDeclared property specifies that the component is being used as a variable but was never declared. More...
 
bool FixedType [get, set]
 The bool FixedType property specifies that the component has been assigned a type which should not be changed by the analyser. More...
 
bool Friend [get, set]
 The bool Friend property specifies that the component has the Friend status, which is derived but which often simply means that it was not explicitly declared to be public or private. More...
 
bool Overload [get, set]
 The bool Overload property specifies that the component needs to be explicitly given the Overload adornment when declared. More...
 
bool Dimensioned [get, set]
 The bool Dimensioned property specifies that the component when declared was explicitly dimensioned via a size or set of size specifications. This size specification is stored as well. More...
 
bool Changed [get, set]
 The bool Changed property specifies that in processing the source code the compiler determined that the value of the component was being changed. This flag is later used by the algorithm that assigns parameters ByVal calling status. More...
 
bool New [get, set]
 The bool New property specifies that the component was declared as being new. More...
 
bool ParamArray [get, set]
 The bool ParamArray property specifies that the parameter component is in fact a parameter array – will contain a variable-length list of objects/values being passed to a subprogram. More...
 
bool InLibrary [get, set]
 The bool InLibrary property specifies that the component is allocated to an external library and its declaration may require extra adornments. This is used in particular with structures that are referenced via declare parameters. More...
 
bool IsDefault [get, set]
 The bool IsDefault property specifies that the component is the default component for its parent. More...
 
bool Collection [get, set]
 The bool Collection property specifies that the component is a collection class or a control vector. More...
 
bool Array [get, set]
 The bool Array property specifies that the component is declared or is referenced as though it were an array even though it may not have been explicitly dimensioned. More...
 
bool D2Array [get, set]
 The bool D2Array property specifies that the component is declared or is referenced as though it were a two-dimensional array even though it may not have been explicitly dimensioned. More...
 
bool Internal [get, set]
 The bool Internal property specifies that the component has been declared to have internal access only. More...
 
bool Protected [get, set]
 The bool Protected property specifies that the component requires the protected adornment when it is declared. More...
 
bool InModule [get, set]
 The bool InModule property specifies that the component is declared within a module file. More...
 
bool Initial [get, set]
 The bool Initial property specifies that when the component is declared it should be initialized with the default initialization value for its type More...
 
bool Resources [get, set]
 The bool Resources property specifies that the component has a set of resources associated with it that were originally stored in an frx file. More...
 
bool Passed [get, set]
 The bool Passed property specifies that the component is a parameter whose calling status is unspecified, that has been passed to another subprogram. This setting is needed to trace the change status of that parameter. More...
 
bool CallBack [get, set]
 When the main analyser logic encounters a reference to the VB6 function AddressOf then it must determine if the use of the AddressOf call is to establish a CallBack. If so then it sets this property true for both the method that is the callback and the argument receiving the AddressOf with the CallBack. More...
 
bool ZeroBased [get, set]
 This property is not set internally, only via refactoring statements. It is used by the analyser to decrement subscripted references to components with this property set true. More...
 
bool WasActiveX [get, set]
 When coclasses that were ActiveX controls are declared they have this property set true. It is used by the author to indicate the need to inherit from the Control class. More...
 
bool HasForEach [get, set]
 This property is attributable to classes and coclasses. When true, it indicates that the component is used in ForEach and must, therefore, implement IEnumerable. More...
 
bool Constructor [get, set]
 This property is attributable to event handlers. When true, it indicates that they are being called directly within the code; therefore, their wrapper event arguments class requires a constructor. More...
 
bool ColObject [get, set]
 This property is attributable to the library whose true entry indicates that a referenced component within the class has a collection type; therefore, the library stub must import VBNET = Microsoft.VisualBasic. More...
 
bool HaveEventArgs [get, set]
 This property is attributable to event handlers whose true entry indicates that they have arguments. More...
 
bool NeedsLet [get, set]
 This property is attributed to library methods to indicate that they are being used to set a property value and thus need a Let. More...
 
bool Implements [get, set]
 When the compiler notes that a component is being used to implement a separate component it sets the implementing component with true. More...
 
bool Shadows [get, set]
 'Shadows' is yet another alternative to 'Overrides' and 'Overloads'. The 'Shadows' keyword indicates that a declared programming element shadows, or hides, an identically named element, or set of overloaded elements, in a base class. You can shadow any kind of declared element with any other kind. The purpose of shadowing is to protect the definition of the class members. It is used with Class, Const, Declare, Delegate, Dim, Enum, Event, Function, Interface, Property, Structure, and Sub Statements. More...
 
bool PropertyBag [get, set]
 This property, when true, tells the property bag processor of the tool to look for BeginProperty and NameValue pairs for this component. More...
 
bool RemoveResumeNext [get, set]
 This property, when true, tells the analyser to turn off the "On Error Resume Next" to try-catch conversions for a particular subprogram. The algorithms used here are fairly robust, but can never be perfect. Specific codes may well encounter problems that are best dealt with by simply turning the algorithms off. More...
 
bool RemoveOnErrorGoTo [get, set]
 This property, when true, tells the analyser to turn off the "On Error Goto" to try-catch conversions for a particular subprogram. The algorithms used here are fairly robust, but specific codes may well encounter problems that are best dealt with by simply turning the algorithms off. More...
 
bool Overloads [get, set]
 This property, when true, requires the Overloads adornment when it is declared within VB.NET as a subprogram. When applied to a parameter, it means that the parameter is an optional argument whose value must be supplied when the subprogram containing it is declared. More...
 
bool CodeAnalysed [get, set]
 This property, when true, indicates that the code associated with a code unit has already been analysed. More...
 
bool TypeInferred [get, set]
 This property, when true, indicates that the type of a component has been inferred. More...
 
bool InInterface [get, set]
 This property, when trye, indicates that a component is in an interface. More...
 
bool OptionBase1 [get, set]
 First if "Option Base = 1", the pass1 compiler marks those variables that have explicit dimensions as having OptionBase1 subscripts; Second, the final pass of the analyser looks for references to the LBound and UBound functions applied to the variables marked and adjusts them by adding 1; Third, the author of the subscripts makes the appropriate adjustment to the dimension value in the declaration of the marked variables. More...
 
bool FixedSource [get, set]
 This property, when true, applies to an ASP page once it has been processed by the Fix logic. Once this is set the page is skipped if it appears in a subsequent pageslice. More...
 
bool ObjectOnly [get, set]
 This property, when true, indicates that a quantity of type Variant or Object should not be type inferred. More...
 
bool BlockTemps [get, set]
 This property, when true, is applied to subprograms. It blocks the formation of a TempArg when converting a Select into an If. More...
 
bool ArrayInfer [get, set]
 This property when true, indicates that a quantity has had its array status inferred based on a reference to it in the code. More...
 
bool Exposed [get, set]
 Only public symbols in classes are exposed in VB6 however in .NET module components can be exposed as well. The SharedFile logic marks these components with a true value for this property. More...
 
bool SharedFile [get, set]
 This property is deprecated and not used currently. More...
 
bool NotByRef [get, set]
 Some value bearing components like members of structures, even in an indexed context, can not be passed by reference. This property , if true, is used to indicate this. More...
 
bool HasCodeHandler [get, set]
 When a refactoring specification for an external component encounters gmSL code it scans that code for transform methods. Any component for which a transform method is found has its this property set true and has its migTransform method set equal to the root offset of the handling user code method. More...
 
bool EnforceType [get, set]
 This property is set true via the refactoring FixType statement. It applies to subprogram parameters and means that any argument passed to this parameter should have the parameter type enforced on it as opposed to doing any type inference. More...
 
bool HasWeakSetter [get, set]
 This property is set true via the refactoring Migrate statement. It applies to library components that have setters. If the attribute is true then the setter is treated as having type "Variant" or "object"regardless of any type associated with the component. It also blocks any type inferences for the component that might be derived from a strongly typed set to it. More...
 
bool HasPatterns [get, set]
 This property is set within the processing of Property statements in external classes. It indicates that the old "GetSetLet" syntax was used to define those patterns. The pattern capabilities were extended to use a generalize pattern syntax and this property blocks a migration that does not apply to the older form. More...
 
bool ConditionalRemove [get, set]
 This property attribute is set true via the refactoring "Remove" statement. It tells the author that rather than stubbing out the code the code should be removed by surrounding it with conditional statements. More...
 
bool ImplicitByRef [get, set]
 This property is set true via the "ImplicitByRef" attribute on the library declaration statement. When it is on, the tool assumes that the .NET compiler will be handling ref arguments implicitly. For the purposes of ByRef optimization, the analyzer will still treat ref arguments as ByRef, but it will not generate temporary arguments. More...
 

Additional Inherited Members

- Protected Attributes inherited from gmslLibrary.Model.tMigInfo
int vector = 0
 

Detailed Description

The tVbControl class controls the content of user defined control description blocks retrieved from a VBI file which specify the content of controls within the various types of VB6 form files, designer files, document files, and user control files. They do not have values and therefore are children of the tMigInfo class.

Constructor & Destructor Documentation

◆ tVbControl()

gmslLibrary.Model.tVbControl.tVbControl ( int  iRoot,
bool  delta = false 
)

The tVbControl constructor obtains a handle to a user control component in the current information storage area which can the used to get and or set the properties of that component. The handle itself is only locally defined and should not be used in extended contexts.

Parameters
iRootThe iRoot parameter specifies the root offset in the currently selected storage area of the desired user control.
deltaThe delta parameter specifies that the code intends to set property values of the component. By default it is false.

Property Documentation

◆ anaCodeStart

int gmslLibrary.Model.tVbControl.anaCodeStart
getset

The integer property anaCodeStart is the offset of the code block that contains the property bag value assignments for the control properties after it has been analysed and transformed. It is this code block that is used to author the declaration of the control.

◆ cmpCodeStart

int gmslLibrary.Model.tVbControl.cmpCodeStart
getset

The integer property cmpCodeStart is the offset of the code block that contains the property bag value assignments for the control properties as produced by the compiler.

◆ ctlType

int gmslLibrary.Model.tVbControl.ctlType
getset

The integer property ctlType specifies the control type code of the control.

◆ formFile

int gmslLibrary.Model.tVbControl.formFile
getset

The integer property formFile contains the root offset of the code form file that contains the control.

◆ iVector

int gmslLibrary.Model.tVbControl.iVector
getset

The integer property iVector is used to control the processing of the members of the control when it is an array. It typically contains the sequence number of the current control array member being processed.

◆ nVector

int gmslLibrary.Model.tVbControl.nVector
getset

If not zero, the integer property nVector specifies that the control ia an array. It specifies the number of members in the array.

◆ nxtVector

int gmslLibrary.Model.tVbControl.nxtVector
getset

The integer property nxtVector is used to control the processing of the members of the control when it is an array. It typically contains the sequence number of the next control array member to be processed.

◆ userClass

int gmslLibrary.Model.tVbControl.userClass
getset

The integer property userClass specifies the class type code of the control.


The documentation for this class was generated from the following file: