Cognex.Designer.Core
Extensions for ApplicationComponent
Determines whether this instance is accessible from the specified zone.
The component.
The zone.
Internal Only
Required so that we may use the JSON convertor to save this to a Large Object.
Raw byte array of the underlying object.
Stores information about a Binding between an Object Property and an Expression
Initializes a new instance of the class.
Gets or sets the binding.
The binding.
Gets or sets property name that this binding is bound to.
The name of the property to bind to.
Gets or sets the expression that the property is bound to.
The expression.
This defines an interface for objects that support binding expressions to it's properties
Gets or sets a value indicating whether this is enabled.
true if enabled; otherwise, false.
Gets all the binding descriptors.
The binding descriptors.
Adds a new binding from a local property to an expression
the name of the local property
the expression to bind to
Gets the binding descriptor for a specific binding.
The binding descriptor.
Removes a binding from the object
The binding to remove
Defines the interface for a binding between a property and an expression
Gets a value indicating whether this is connected.
true if connected; otherwise, false.
Gets the destination object.
The destination object.
Gets the destination path.
The destination path.
Gets or sets a value indicating whether updates for this are enabled.
true if enabled; otherwise, false.
Gets the source expression for the binding.
The source.
Structure that represents a 2D rectangle boundary.
Gets or sets the left position of the boundary.
The left position of the boundary.
Gets or sets the top position of the boundary.
The top position of the boundary.
Gets or sets the width of the bounded area.
The width of the boundary.
Gets or sets the height of the bounded area.
The height of the boundary.
Gets or sets the rotation of the bounded area.
The rotation of the boundary.
Provides the required information for the BrowsableDataChanged event.
Initializes a new instance of the class.
The browsable object where the data changed.
Gets the browsable object where the data changed.
An instance of the IBrowsableObject.
Specifies a category for the target class, method or property.
Initializes a new instance of the class with a category.
The category text.
Initializes a new instance of the
using the string from a resource file that is identified by .
The auto-generated resource class that contains the string to
lookup.
The resource key of the localized string to use.
Gets the Category stored in this attribute
The category.
Specifies a default name for a component.
Initializes a new instance of the class with a display name.
The component name.
Gets the default component name.
The component name.
Specifies that the a property or function should not be parsed and showed by the intellisense
Used for hiding maintenance functions or functions/constructors that exist on the C# side but not on the JavaScript side.
Specifies a zone for the target.
Initializes a new instance of the class.
The Zone.
Gets the Zone of the Component and its children.
Specifies a description for the class, method or property.
Initializes a new instance of the class with a description.
The description text.
Initializes a new instance of the
using the string from a resource file that is identified by .
The auto-generated resource class that contains the string to
lookup.
The resource key of the localized string to use.
Gets the description description stored in this attribute.
The description text.
Specifies a display name for a component.
Initializes a new instance of the class with a display name.
The display name text.
Initializes a new instance of the
using the string from a resource file that is identified by .
The auto-generated resource class that contains the string to
lookup.
The resource key of the localized string to use.
Initializes a new instance of the class with a display name.
The display name text.
The display name short text.
Initializes a new instance of the
using the string from a resource file that is identified by .
The auto-generated resource class that contains the string to
lookup.
The resource key of the localized string to use.
The display name short text.
Gets the display name.
The display name.
Gets the short display name.
The short display name.
Calculates the value of an object.
Updates the value based on the actual value of the expression and the association table.
Represents a node in the expression tree that can be evaluated to a .Net object.
Raised when the property changed.
Gets child nodes.
Raises the event.
Registers an expression function.
The signature of the function including argument list or only the function name to automatically generate signature from name and arguments.
Human-readable comment.
Function implementation.
Represents a node that calculates its value based on its child nodes.
Gets the number of available function overloads.
Updates the value of the node.
Resolves escape sequences in input string and quoting around it.
Reports the number of occurrences of the specified string in the current object.
The string to seek.
Specifies whether overlapping strings are counted as separate instances or not.
One of the enumeration values that specifies the rules for the search.
is null.
is not a valid value.
Reports the number of occurrences of the specified string in the current object.
The string to seek.
The search starting position.
Specifies whether overlapping strings are counted as separate instances or not.
One of the enumeration values that specifies the rules for the search.
is null.
is not a valid value.
Reports the number of occurrences of the specified string in the current object. Parameters specify the starting search position in the current string, the number of characters in the current string to search, and the type of search to use for the specified string.
The string to seek.
The search starting position.
The number of character positions to examine.
Specifies whether overlapping strings are counted as separate instances or not.
One of the enumeration values that specifies the rules for the search.
is null.
or is negative.-or- is greater than the length of this instance.-or- is greater than the length of this instance minus .
is not a valid value.
Gets a common base class for the types in the array.
Gets a common base class for the types in the array.
Gets the name of the constant used to identify it.
Gets user information for the constant.
Gets the value of the const;
Gets the name of the function used to identify it.
Gets the signature of the function shown in intelli-sense. This includes the name of the function, the type and name of the input parameters and the type of the return value.
Gets user information for the function.
Decides whether the function can be evaluated with the given arguments.
This method is used to find appropriate overload.
Validates the current arguments and throws exception in case of any error.
Gets the type of the returned object given the specified arguments.
Evaluates the function and returns a value.
Represents an atomic element of the expression string.
Initializes a new instance of the class.
Text of the input token.
Qualified text of the input token.
Index of the token in the expression string.
Index of the line containing the token in the expression string.
Character position of the token in the containing line.
Shifts the token in the expression string from left to right.
Number of line shifted.
Character position changed.
Represents an element in the expression, either terminal or non-terminal.
Get the associated with the current instance.
Gets the semantic of the token.
Gets a string representation of the token sequence. The stirng contains the type of each token separated with a single colon (;) character.
Terminal tokens are pre- and suffixed by a single percentage (%) character.
Example: identifier;operator07;%literal%
Represents a designer expression tree.
Implements the ITag interface and automatically re-evaluates its value when any child expression is updated.
Initializes a new instance of the class.
Event that occurs when the data is no longer accessible.
High priority event that occurs when the tag value changes
Use for higher priority events (i.e. Communications). Do not update UI on this event
Low priority event that occurs when the tag value changes
Should be used for user-interface updates
Gets a list of supported functions.
Gets a list of supported constant values.
Gets or sets the category of the expression. This is set to ExpressionTag by default.
The category.
Gets or sets the comment, this is used to display a user friendly representation of the expression.
The comment text.
Gets the data type of the tag.
The data type of the tag.
Gets or sets the expression.
The expression.
Gets the qualified expression (regardless in what letter-case is it typed in).
The expression.
Gets a value indicating whether the data belonging to this tag is available and connected.
true if the tag value is connected; otherwise,
false.
Calling the
or
method when this value is false may result in an exception.
Gets a value indicating whether this instance is read only.
true if this instance is read only; otherwise, false.
Gets a value indicating whether this expression is obsolete and should not be used.
true if this expression is obsolete and should not be used; otherwise,
false.
The project verification tool will detect references to obsolete expressions.
Gets information about the obsolete nature of this expression.
The obsolete information.
This is usually a message on what to replace the expression with.
Gets the component that owns this expression instance.
The IApplicationComponent owner.
Gets or sets the current value of this expression.
The value.
Cognex internal use only.
Creates a proxy that can be used to access this instance.
A new tag proxy object.
Validates the expression with current tag configuration.
Thrown if the expression cannot be evaluated.
Sets the value of this expression.
The new value to set.
Gets the current value of this expression.
The current value of the expression.
Gets the tags referenced by the expression.
Gets the tags referenced by the expression matching the given regular expression.
Replaces all references to a given tag with a new path.
The path of the tag to replace.
The new tag path.
true if any occurrences have been replaced; false otherwise.
Contains information for an expression and its corresponding association table.
Initializes a new instance of the class.
Gets or sets the expression text for this instance.
The expression text.
When the get is called, it always attempts to get an up-to-date expression, including any renames that have occurred.
Gets or sets the active expression tree for this instance.
The expression tree.
Getting this property will attempt to create the expression if it had not been previously created.
Gets a value indicating whether the data belonging to this expression is available and connected.
true if the tag value is connected; otherwise, false.
Gets the type of the expression.
Gets the exprected return type of the expression.
For Cognex internal use only.
Gets or sets the table of associations used when evaluating this instance.
The association data table.
Gets or sets the associations of the expression.
Clones this instance.
A copy of the ExpressionData.
Gets a tag proxy that can be used to access this data.
Sets the value of this expression.
The new value to set.
Gets or sets the project password.
The project password.
Gets or sets the name of the project.
The name of the project.
Gets or sets the hint path for the project
The path to the project file that was loaded.
This is useful when attempting to save a project that was recoverred from a running In-Sight Controller
Gets or sets the version.
The version.
Represents a large object that is embedded in the project content and stored as a base64 string.
Gets or sets the large object data as a base64 string.
The base64 data.
Gets or sets the large object data.
The large object byte array.
Implicitly converts ByteArray to byte[].
The ByteArray object.
Provides the ability for different modules to register converters for the whole application
Gets the default converter for the entire application.
The default converter.
Gets a default large object table for the entire application.
The default large object table.
Represents a large object that is embedded in the project content and stored as a base64 string.
Gets or sets the large object data as a base64 string.
The base64 data.
Gets or sets the large object data.
The large object byte array.
Represents a reference to a large object that is being stored separately in a .
Gets or sets the path in the table that this value is stored.
The path to the large object.
Simple converter to save/load the objects properties marked by the .
A composite that wraps multiple converters into a single instance.
A project factory that contains other project factories and selected based on the type of object being saved.
A that stores large object data in a separate table that can be serialized separately from the project content.
A that stores large objects as binary data to be serialized inside the project content data.
A large object handle that is returned whenever a object is stored within a .
Gets or sets the type of the large object data
The type of the large object.
Represents a converter that handles the conversion of large object values to and from binary.
Determines whether this instance can convert the specified type.
The type to convert.
Returns true if the converter can handle the specified type.
Converts the object to a byte array.
The large object value to convert.
A byte array representing the specified object.
Writes the object to a destination stream.
The large object value to convert.
/// The stream to write the data to.
Converts the byte array into an object.
The type of the large object.
The data to convert.
A new large object.
Converts the stream into an object.
The type of the large object.
The stream to read the data from.
A new large object.
Represents a large object storage instance.
Stores a large object and returns a placeholder large object to be used in place of the original object value.
The path that the value should be stored.
The large object value to be stored.
A large object placeholder that represents the stored object.
Determines whether the specified path contains path.
The path.
Gets whether the specified type should be stored as a large object.
The type of the object.
Returns true if the type should be stored as a large object
Gets the real value of the large object given the LargeObject handle
A large object handle that can be used to retrieve the original value.
The original large object.
Provides functionality required by all Content Factories.
Use by .
Determines whether this instance can create the specified type.
The type to create.
Returns true if this factory can convert the type.
Converts a component into a ProjectContent
Component to be converted
ProjectContent populated with data from .
Creates a new object from data in the .
Content containing all relevant information.
New .
Represents a source for application project data.
Retrieves the project content data for the specified path.
The path to retrieve the data for.
A project content describing the component at the specified path.
Retrieves string data from the specified path.
Retrieves the meta data for the specified path.
Type of the meta data.
Path to meta data
An object T, which describes the meta data
Gets a large object table that contains resource data that is referenced from the project content.
The large object reference table.
Holds the factories used by the serializer to convert between and .
Clears all registered factories, but leaves the default factory.
Registers the to be used for conversion
between and ,
A factory that can perform a conversion.
Creates an object using information stored in the .
Content with source information.
Converts all SubContents of the as well.
A new component object populated with data from the .
Used during deserialization.
Creates an object using information stored in the .
The object to be converted.
Converts all ChildComponents of the as well.
The new object.
Used during serialization.
Contains commonly used Apply and Fill methods used by classes.
Adds the binding information from the into the .
Component to be updated
Content with information
Sets the property values with the from the into the .
Component to be updated
Content with property values
Sets the property values from the into the .
Component to be updated
Content with property values
Filters properties by these attributes.
Creates an set with the 's name and type.
Component to get name and type information from.
with name and type set.
Creates an using the type provided by ContentTypeId and sets its name.
Content to be converted.
ProjectComponent based on the content.
Populates the with all binding settings from the .
An component.
Content to be populated
Populates the with all public properties from the
with the supplied .
Component's whose properties will be saved.
Content to be populated.
Attributes used as markers to save the properties value.
Populates the with all public properties from the
with the supplied .
Component's whose properties will be saved.
Content to be populated
Removes the component identified in the Host.Register with the supplied .
Name of the component being removed.
Calls the component's parent's RemoveChild method.
Components to be removed.
Retrieves the value of the property called from the .
Type of the properties value.
Content containing all properties values.
Property name
Value of the property.
Checks the to see whether the exists.
Content containing all properties values.
Name of property
True when the content contains the property
Adds or updates the property with new value in the content.
Content containing all properties values.
Property name
Value to set the property too.
A cache of ResourceManagers associated with a strongly typed auto-generated Resources class.
Constructor that prevents a default instance of this class from being created.
Finds the ResourceManager associated with the given strongly-type Resources class.
The type that is auto-generated from a resx file and contains a
ResourceManager class.
A ResourceManager.
Switch all services out of Run mode
Switch all services into Run mode
Starts the services.
Stops the services.
Clears all project data for each service
Loads all project data for each service from the current project.
Indicates that this object can automatically handle importing
templates, and does not require extra information (e.g. a position on a Page\Sequence).
This is only compatible with a class the implements IProjectComponentContainer.
Class CustomObjectProperty
Performance is not optimized. Avoid using this for any runtime. Designed for use with the IDE.
Initializes a new instance of the class.
The owner of the property.
The property info.
Occurs when child properties are changed.
Occurs when property value is changed.
Occurs when property display name is changed.
Occurs when property read only is changed.
Gets the category that the property belongs to.
The category.
Gets the description of the property.
The description.
Gets the order of the property in the specified category.
The order in the specified category
Gets all the child properties of this instance.
The child properties.
Gets the value of this property when in development mode.
The value while in development mode.
Gets the user display name of this property.
The display name.
Gets the editor options that are used to configure the editor.
The editor options.
Gets the editor type used to edit this property.
The editor type.
Gets a value indicating whether this instance is bindable.
true if this instance is bindable; otherwise, false.
Gets a value indicating whether this instance is editable.
true if this instance is editable; otherwise, false.
Gets a value indicating whether this instance is expanable.
true if this instance is expanable; otherwise, false.
Gets a value indicating whether this instance is read only.
true if this instance is read only; otherwise, false.
Gets the name of this property.
The name.
Gets the owner of this property.
The owner.
Gets the path to access this property.
The path.
Gets or sets the parent property.
The parent.
Gets the data type of the property.
The type.
Gets or sets the value of the property.
The value.
Gets a specific child property of this instance.
The child property.
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Subscribed to child CustomObjectProperties' ValueChanged event
Releases unmanaged and - optionally - managed resources.
true to release both managed and unmanaged resources; false to release only unmanaged resources.
Subscribes to target property's PropertyChanged event
Interface for components that need to be connected to and the disconnection/reconnection will be handled by the device manager
Gets a value indicating whether this component is connected.
true if this instance is connected; otherwise, false.
Runs an active connection check
Connects to the component
Disconnects from the component.
Gets a value indicating whether this service should be run in development mode.
true if service should be started in development mode; otherwise, false.
Gets or sets a value indicating whether this is enabled.
true if enabled; otherwise, false.
Gets the name of the Service
Start the Service
Stop the Service
Occurs when the components enabled status changes.
Gets the name of the service.
Determines whether this instance is enabled in development mode.
true if this instance is enabled in development mode; otherwise, false.
Called when the service is started.
Called when the service is stopped.
Called when enabled.
Called when disabled.
Called when a service started with a new project.
Class for managing a component references.
Creates a new Rerenced component for the given item with full access
The referenced item's name
The referenced item's type
Creates a new ReferencedComponent instance with the given accesss level
The referenced item's name
The referenced item's type
The access level restriction which is required for the given reference
Creates a new ReferencedComponent instance with the given accesss level
The referenced item's name
The referenced item's type
A method which will allow the user to determine the access level during runtime
Gets the item's name which is referenced by this component
Gets the type of the referenced component
Gets the Access level of the current component.
Rerturns the allowed access level
Class SystemTypeResolver. Manages the resolving of types to and from string.
Initializes static members of the class.
Gets whether a type association exists for the specified name.
The name of the type to get.
The data type.
Checks to see whether a type is valid. Can help prevent unnecessary error logging by just using the TypeToName.
Check the SystemTypeResolver for the existence of the given type in its list of definions
Type of the object
True if the System Type Resolver contains an entry for the given type.
Gets the .net data type from a name.
The name of the type to get.
The data type.
Converts the data type into a short name.
The type to convert.
The short name of the type.
Adds the type mappings for all types within the assemblies that contain a DataContract or TypeName attribute.
The assembly to load type mappings for.
The DataContract attribute must provide a non-null Name value.
Adds a type association between a string name and a .net type.
The short name for the type.
The type.
Gets the type of the Cognex Designer.
Name of the type.
Type.
Builds the initial type association table.
Interface to allow Exporting of an item to a
Check to see that the current state of the object can be exported
True when the item can perform an export
Packages this object into a , ready for serialization.
The object wrapped into a
Defines the type of an application service
Core service
Basic service
Device service
UI service
Additional services
None
ApplicationService class. Provides the default implementation of the IApplicationService interface
Initializes a new instance of the class.
Gets a value indicating whether this service should be run in development mode.
true if service should be started in development mode; otherwise, false.
Gets or sets a value indicating whether this is enabled.
true if enabled; otherwise, false.
Gets the name of the Service
Start the Service
Stop the Service
Occurs when the components enabled status changes.
Gets the name of the service.
Determines whether this instance is enabled in development mode.
true if this instance is enabled in development mode; otherwise, false.
Called when the service is started.
Called when the service is stopped.
Called when enabled.
Called when disabled.
EventArgs for an event that involves an application component.
Initializes a new instance of the class.
The handle.
Gets the handle of the component involved.
The handle.
IApplicationService Interface. Provides the interface for Designer services
Gets the name of the Service
Gets or sets a value indicating whether this is enabled.
true if enabled; otherwise, false.
Start the Service
Stop the Service
Interface used by components that depend on other components.
Used to detect broken links between components.
Gets the list of other components referenced by this component and their expected data types.
an enumerable of string, type pairs that show the referenced component and it's data type
Specifies the application layer for a service type to define startup order
Creates a new instance of the Layer attribute
The application layer to use
Creates a new instance of the Layer attribute
The application layer to use
Specifies the load order of the add-in. Modules with lower values will be loaded first. Negative values are reserved for internal use only.
Gets the application layer.
The layer.
Gets the load order of the add-in. Modules with lower values will be loaded first. Negative values are reserved for internal use only.
Provides a set of static methods for exploring object properties and methods.
Attempts to convert the value into a settable type. And then applies it to the .
Object who's property will be set.
Information about the property being set.
Value to set.
Gets the name, category and description for a provider.
The subject to get the information from.
The name, description and category.
Gets the name, category and description for a provider.
The custom attribute provider
The name, description and category.
Gets the parameters for the component.
The component to get parameters from.
An array of parameters used to configure the specified component.
Gets a set of parameters for the provider
The type to get the parameters from.
An array of parameters used to configure the specified type.
Gets the links between parameters of the specified component.
The component to get the links from.
Internal.ParameterLink[][].
Gets a set of links between parameters for the provider
The attribute provider.
An array of links between parameters.
Gets the set of custom properties from the specified component.
The component to get properties from.
An array of custom properties.
Gets the set of custom properties from the specified component.
The component to get properties from.
if set to true [ignore dynamic provider].
An array of custom properties.
Gets the custom property at the specified path.
The object to get the property from.
The path to access the property at.
A custom property object to access the property.
Gets the set of custom properties with the corresponding attributes attached.
The data type to get the property info from.
The attribute types.
An array of property info objects
Gets the property value.
The object containing the property.
Name of the property.
The value of the property.
Sets the property value.
The object containing the property.
Name of the property.
The property value to set.
Sets a list of property values.
The object to set the property values on.
The data to set.
Provides utility functions for the application register.
Gets whether the renaming of the current handle to the newName string is valid and will succeed.
Determines whether the specified name is valid as as component short name.
The name to validate.
true if the name is valid; otherwise, false.
Determines whether the specified full name (i.e namespace) is valid.
The name.
true if the name is valid; otherwise, false.
Converts the name to safe name that can be registered.
The name to convert.
A safe name that can be registered.
Class SystemTypeResolver. Manages the resolving of types to and from string.
Initializes static members of the class.
Adds the type mappings for all types within the assemblies that contain a DataContract or TypeName attribute.
The assembly to load type mappings for.
The DataContract attribute must provide a non-null Name value.
Adds a type association between a string name and a .net type.
The short name for the type.
The type.
Adds a type association between a string name and a .net type.
The short name for the type.
The type.
Gets whether a type association exists for the specified name.
The name of the type to get.
The data type.
Checks to see whether a type is valid. Can help prevent unnecessary error logging by just using the TypeToName.
Check the SystemTypeResolver for the existence of the given type in its list of definions
Type of the object
True if the System Type Resolver contains an entry for the given type.
Gets the .net data type from a name.
The name of the type to get.
The data type.
Converts the data type into a short name.
The type to convert.
The short name of the type.
Removes all type associations. Required for testing, do not use in production code.
Required for testing, do not use in production code.
Gets the type of the Cognex Designer.
Name of the type.
Type.
Builds the initial type association table.
Provides a set of constants that specify the keys for different type editors.
Conversion class for handling the conversion of values between different types.
Changes the value to the specified destination data type.
The value to convert.
The type to convert the value to.
The format provider.
if set to true and the destinationType is a ValueType, a null value will be converted to a default value.
destinationType
Can't convert null to value type
or
Unable to convert to the destination type.
Interface used by HMI elements to provide properties that have different design-time and run-time values.
This interface should not be directly implemented by the user.
Gets the current value of the specified property. This takes into account the current design/run state of the component.
The property to get the value for.
The current value.
Gets the value locally stored within this instance. This may represent a design time value and not the current active value.
The property to get the local value for.
The locally stored value.
Registers a new notification property within this element.
The name of the property.
The data type of the property.
The default local value of the property.
The design time value of the property.
a new NotifyProperty object.
Should only be called once per instance.
Registers a new notification property within this element.
The name of the property.
The data type of the property.
The default local value of the property.
The design time value of the property.
A delegate function that validates the value before applying.
A delegate that gets called when the property value changes.
a new NotifyProperty object.
Should only be called once per instance.
Resets all property values back to the default.
Resets the specified property back to default.
The property to reset.
Sets the local value of the property.
The property to set.
The new local value.
Helper that can be used when implementing the INotifyObject interface.
Initializes a new instance of the class.
Delegate used to notify when the property value has been changed.
Delegate used to validate changes
The value to validate.
Returns true if there is no problems with the value.
Enters the design mode by setting all property values to their design-time value.
Exits the design mode by setting all property values to their locally set value.
Gets the current value of the specified property. This takes into account the current design/run state of the component.
The property to get the value for.
The current value.
Gets the value locally stored within this instance. This may represent a design time value and not the current active value.
The property to get the local value for.
The locally stored value.
Resets the specified property back to default.
The property to reset.
Sets the local value of the property.
The property to set.
The new local value.
Registers a new notification property within this element.
The name of the property.
The data type of the property.
The default local value of the property.
The design time value of the property.
a new NotifyProperty object.
Should only be called once per instance.
Registers a new notification property within this element.
The name of the property.
The data type of the property.
The default local value of the property.
The design time value of the property.
A delegate function that validates the value before applying.
A delegate that gets called when the property value changes.
a new NotifyProperty object.
Should only be called once per instance.
Resets all property values back to the default.
Raises the property changed.
Name of the property.
NotifyObject class. Provides a default implementation of the INotifyPropertyChanged interface
A dictionary to store errors for each property. Defer initialization to improve performance when there is no error management.
Occurs when a property value changes.
Occurs when the validation errors have changed for a property or for the entire entity.
Gets a value that indicates whether the entity has validation errors.
true if the entity currently has validation errors; otherwise, false.
Gets the validation errors for a specified property or for the entire entity.
The name of the property to retrieve validation errors for; or null or , to retrieve entity-level errors.
The validation errors for the property or entity.
Gets an error message indicating what is wrong with this object.
An error message indicating what is wrong with this object or null for no error.
Gets the error message for the property with the given name.
The name of the property to retrieve validation error for; or null or , to retrieve entity-level error.
The error message for the property or null for no error.
Sets an error message indicating what is wrong with this object.
An error message indicating what is wrong with this object or null for no error.
Sets the error message for the property with the given name.
The name of the property to set validation error for; or null or , to set entity-level error.
The error message for the property. Provide empty string ("") for no error.
Clears the error message for the object.
Clears the error message for the property with the given name.
The name of the property to clear validation error for; or null or , to clear entity-level error.
Clears all property errors and the error associated with the current object.
Raises the event.
The name of the property.
Raises the PropertyChanged event.
The property expression.
Raises the event.
A that contains the event data.
Raises the event.
Raises the event.
The name of the property.
Raises the event.
A that contains the event data.
Gets the name of a property from a property expression.
The property expression.
Represents a notification style property. Notification properties are used for property that have different behavior in Design-time and Run-time.
Initializes a new instance of the class.
The name of the property.
The expected data type of the property.
The default value of the property.
The design-time value of the property.
Initializes a new instance of the class.
The name of the property.
The expected data type of the property.
The default value of the property.
The design-time value of the property.
validation delegate used to validate the property change.
change applied callback used to notify when the property value is changed.
Gets the expected data type of the property.
The property data type.
Gets the name of this property.
The property name.
Gets the current value of this property
The current value.
Gets the local (run-time) value of this property
The local value.
Gets the default value of this property.
The property default value.
Gets the design-time value of this property.
The design-time value.
Sets the locally stored value for this property.
The new local value.
Sets property to use the locally stored value.
Sets the property to use the design-time value.
Gets the current value of the property depending on the current mode.
The current value.
A mode specifying the behavior of a notify property.
The default value of the notify property should be used.
The local value of the notify property should be used.
The design-time value of the notify property should be used.
Default implementation of the interface. This is used as a base class by most Designer components.
Gets or sets the handle that refers to this instance.
The handle instance.
This should not be set by the user, this could cause un-expected behavior.
Called when the instance is registered inside the Designer register.
Occurs when this component's handle's name is changed.
Derived classes should override this method when needing to execute code after component registration.
Executed after notifying all the NameChanged event listeners.
Safely retrieve the handle's name infomation, by taking into
account that the Handle or Handle.Name could be null.
The full name of the component.
To be used for exception logging.
Interface used for devices that support automatic discovery of available tag addresses.
Occurs when the list of available data for this component has changed.
Indicates to designer that the list of available data should be refreshed.
Gets a list of available tag addresses for the specified parent node.
The parent address (if applicable).
A new set of available tag addresses.
For the first call, the parent variable will be null.
Determines whether the specified tag address has children.
The parent tag address.
true if the specified parent has children; otherwise, false.
Cognex Internal Use Only
Occurs when any of the child properties change.
Occurs when the custom property value is changed.
Occurs when the custom property display name is changed.
Occurs when the custom property read-only status is changed.
Gets the category that this property belongs to.
the category text.
Gets the description for this property.
the desxcription text.
Gets the order of the property within the specified category.
an integer order within the specified category
Gets all the child properties of this instance.
An array containing all child properties.
Gets the value of this property when in development mode.
The value while in development mode.
Gets the user display name of this property.
The display name text.
Gets the type id of the editor required to edit this property.
The editor type string.
Gets the editor options that are used to configure the editor.
An object array of editor options.
Gets a value indicating whether this property is bindable.
true if this instance is bindable; otherwise, false.
Gets a value indicating whether this property is editable.
true if this instance is editable; otherwise, false.
Gets a value indicating whether this property is expandable.
true if this instance is expandable; otherwise, false.
Gets a value indicating whether this property is read only.
true if this instance is read only; otherwise, false.
Gets the name of this property.
The name text.
Gets the owner of this property.
The owner object.
Gets the path to access this property.
The path.
Gets or sets the parent property.
The parent property.
Gets the expected data type of the property.
The data type of the property.
Gets or sets the current value of the property.
The object value.
Gets the specified child property of this property.
An ICustomProperty child property.
This represents the application that is hosting the Designer editor and runtime
Occurs when Designer is shutting down.
Occurs when Designer is shutting down.
Interface for components providing access to internal or wrapped objects.
Used by the $System.GetInternalObject() method to return internal objects.
Gets the internal object contained within this component
an internal object owned by the implementor.
Gets the user friendly / readble event name
Gets the underlying original Event name.
Contains methods for retrieving custom attributes from objects
Generic method to retrieve a single attribute from an provider.
The attribute type.
The provider that contains the attributes.
An attribute of the specified type.
Generic method to retrieve a single attribute from an provider.
The attribute type.
The provider that contains the attributes.
An attribute of the specified type.
Generic method to retrieve a array of attributes from an provider.
The attribute type.
The provider that contains the attributes.
An array of attributes of the specified type.
Generic method to retrieve a array of attributes from an provider.
The attribute type.
The provider that contains the attributes.
An array of attributes of the specified type.
Attribute that marks the type as for use in Development Mode only
Attribute that defines which application dispatcher should be used for the class
Initializes a new instance of the class.
The dispatcher id.
Gets the Dispatcher Id
Specifies an icon for the target
Initializes a new instance of the class.
The icon path.
Initializes a new instance of the class.
The icon path.
The assembly.
Gets the assembly.
The assembly.
Gets the path.
The path.
Gets the URI.
Uri.
Marks the class or property to be ignored by Designer
Marks the target as being managed by the application and not accessible directly to the user
Gets the description for this property.
The description.
Occures when property list has been changed.
Determines whether the provider contains the specified property.
Name of the property.
true if the specified provider contains the property; otherwise, false.
Gets the property from the provider.
Name of the property.
A ICustomProperty for the specified property.
Gets an array of dynamically created properties.
An array of properties.
Provide information to this Dynamic command about it's bindable parent.
The bindable object that owns this command.
The path that this command is bindable through.
A number of options on how to resolve a conflict.
Used primarily for templating.
Uses the default conflict resolution.
Do not attempt to change anything, and error if necessary.
Display a dialogue for the user to manually resolve any conflicts.
Rename any conflict automatically.
Rename any conflict automatically, but still show a prompt to allow the user to make any final changes.
Overwrite any conflicting items, by replacing them.
Overwrite any conflict automatically, by replacing them, but still show a prompt to allow the user to make any final changes.
Defines the interface for an object that generates events
Event the occurs when the event source generates a trigger
Gets a list of events that this object generates
An array of events that this object generates.
To be used to display the object in the Project Settings
Name to be displayed when selecting this object.
Identifies the object as a something which has an IProjectSetting object.
Returns this objects setting.
Defines the interface for dispatcher objects to execute delegates on other threads
Invokes a method on the dispatcher thread without waiting the method to complete
the delegate method to execute
the arguments to the delegate method
Invokes a method on the dispatcher thread and waits for it to complete executing
the delegate method to execute
the arguments to the delgate method
the return value of the delegate method
Class SystemClock
Gets the total elapsed time measured by the current instance, in tenths-of-a-millisecond.
If the returned value is '10000', it means the interval took exactely one second.
A long that contains the time that has passed since creating this instance.
Gets the milliseconds.
The milliseconds.
Gets the total elapsed time measured by the current instance, in tenths-of-a-millisecond.
If the returned value is '10000', it means the interval took exactely one second.
A long that contains the time that has passed since creating this instance.
Gets the system milliseconds.
System.Double.
Designer wrapper for the Parallel Task library. Tracks the number of concurrent tasks and category.
Prevents a default instance of the class from being created.
Starts a new parallel task for the specified action
The action to execute.
The category of the task.
Task.
Starts a new parallel task for the specified action
The action to execute.
The category of the task.
The cancellation token.
Task.
Class ThreadDispatcher
Begins the invoke.
The dispatcher id.
The method.
The args.
Invokes the specified dispatcher id.
The dispatcher id.
The method.
The args.
System.Object.
Registers the specified dispatcher id.
The dispatcher id.
The dispatcher.
Internal use only - Used to clean up in TestSystem.CleanUp
Gets the Zone of this instance.
Returns null, if there is no Zone defined for this component.
Serializes the specified into the .
The object value to serialize.
The stream to serialize the object to.
Serializes the specified object to text.
The object value to serialize.
Deserializes an object from stream.
The type of the object being deserialized.
The stream to deserialize the object from.
The deserialized object.
Deserializes an object from text.
The type of the object being deserialized.
The text containing the data to deserialize.
A new instance of the object.
Deserializes an object from stream.
The type of the object being deserialized.
The stream to deserialize the object from.
The deserialized object.
Deserializes an object from text.
The type of the object being deserialized.
The text containing the data to deserialize.
A new instance of the object.
Serializes the object and then deserializes it back.
The type of the object being serialized.
The object. to clone.
A cloned instance of the object.
Deserializes an object from stream.
The stream to deserialize the object from.
The type of the object being serialized.
The deserialized object.
Deserializes an object from text.
The text containing the data to deserialize.
The type of the object being serialized.
A new instance of the object.
Serializes the object and then deserializes it back.
The object. to clone.
The type of the object being serialized.
A cloned instance of the object.
Provides functions for serializing and deserializing objects.
Deserializes the specified stream.
The stream.
``0.
Deserializes the specified text.
The text.
``0.
Deserializes the specified stream.
The stream.
``0.
Deserializes the specified text.
The text.
``0.
Deeps the clone.
The obj to clone.
``0.
Serializes the specified stream.
The stream.
The value.
ID of the serializer to use.
If the set to null or empty, Designer will attempt to use the
best fit for the type of .
Serializes the specified stream.
The stream.
The value.
ID of the serializer to use.
If the set to null or empty, Designer will attempt to use the
best fit for the type of .
Contains information about a single startup error that occurred during Designer startup.
Initializes a new instance of the class.
Initializes a new instance of the class with an error message
The error message.
Initializes a new instance of the class with an error message and exception
The error message.
The exception details.
Initializes a new instance of the class with an error message, exception and group.
The error message.
The exception details.
The error group.
Gets or sets the name of the group this error belongs to.
The name of the group.
Gets or sets the error message displayed to the user.
The error message.
Gets or sets the exception that is associated with this error.
The exception.
Gets a value indicating whether this instance has an exception attached.
true if this instance has an exception; otherwise, false.
Class TriggeredEventArgs
Initializes a new instance of the class.
Name of the event.
Gets the name of the event.
The name of the event.
A with unique identifier.
Cognex internal use only.
Cognex internal use only.
Gets a new, unique integer value.
Interface for an object that defines dynamic properties
Determines whether the provider contains the specified property.
Name of the property.
true if the specified provider contains the property; otherwise, false.
Gets the property from the provider.
Name of the property.
A ICustomProperty for the specified property.
Gets an array of dynamically created properties.
An array of properties.
Occures when property list has been changed.
Class AbortStartupException
Initializes a new instance of the class with a specified error message.
The message that describes the error.
Display an error dialog with the exceptions message.
Initializes a new instance of the class with a specified error message and a reference to the inner exception that is the cause of this exception.
The error message that explains the reason for the exception.
The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified.
Display an error dialog with the exceptions message.
Dependency Manager class, manages resolving unknown assembly references.
Registers the dependency path.
Name of the component.
The directory.
Gets the dependency paths for the specific component.
Name of the component.
An array of paths for the specific component.
A proxy used to connect to other Handles
Creates a new Instance of the HandleProxy class
The name of the proxy
Gets or sets the referenced handle.
The referenced handle.
Cognex internal use only.
Class Host
Gets or sets the instance of the IFunctionManager service
The function manager
Gets or sets the application component register.
The application register.
Gets or sets the instance of the ITagManager service.
The tag manager service.
Interface to addin controller servicer
Creates a new instance of the plug-in component.
The addin plug-in type.
The name to register the instance under.
The parent to the component.
A new instance of the specified plug-in component.
Creates a new instance of a plug-in component
the type of the application component
A new instance of the specified plug-in component.
Creates a new instance of a plug-in component
the type of the application component
A new IApplicationComponent object
Deletes the specified IApplication Component object
The component to delete.
Class InvalidConfigurationException
Initializes a new instance of the class with a specified error message.
The message that describes the error.
Defines the interface to the application register.
Occurs when a component is added to the register.
Occurs when a component is removed from the register.
Occurs when a component is being removed from the register.
Occurs when a component is renamed in the register
Occurs when component is added, removed or the entire tree has been refreshed.
Changes the Name of a component
The current name of the component
The new name of the component
Changes the name of a component
A handle to the component
The new name of the component
Changes the name of a component
The component to change the name for
The new name of the component
Changes the name of a component
A handle to the component
The parent of the component.
Checks to see if a component exists with the specified name
The name of the component to look for.
true if the component exists; otherwise, false.
Checks to see if a component exists with the specified Handle Ptr value
The handle of the component to look for.
true if the component exists; otherwise, false.
Finds all components that inherit from the specified base class
The base class type to look for
An array of compatible components
Finds all components that inherit from the specified base class
The base class type to look for
An array of compatible components
Gets a component from its handle
The ptr of the component to get.
The specified component.
Gets a component from its name
The name of the component to get.
The specified component.
Gets a complete list of all components loaded in
An array of all components
Gets a handle to a component from its name.
The name of the handle to get.
The requested handle.
Gets a proxy handle for the specified component name
The name of the handle to get.
A handle proxy object.
This function will always successfully return a handle even if a component doesn't exist.
Use the connected property and events to detect when a component is added/removed/available
The method must be called to prevent memory leak.
Adds a new component into the Register
The component to add
Adds a new component into the Register
The component to add
The parent of the component to add
Adds a new component into the Register
The component to add
The name the component should be registered under.
Adds a new component into the Register
The component to add
The name the component should be registered under.
The parent of the component to add.
Removes the component.
The component to remove.
Removes the component.
The handle of the component to remove.
Removes the component.
The name of the component to remove.
Cognex internal use only.
Component index
Tries the get handle.
The name of the handle to get.
The handle that is being returned.
true if the handle exists; otherwise, false.
Gets a complete list of all components loaded in and accessible from the given Zone.
The zone.
Determines whether the specified zone to accessible from the specified accessing Zone.
The zone to access.
The accessing zone.
Registers a new accesibility rule.
The Zone to access.
The current Zone.
Gets the default component zone.
Enum ItemChangedMode
Added
Removed
Defines the interface to an object that provides a set of types.
Gets the types.
The types.
Defines a two layered dictionary structure
The type of the category key
The type of the name key
The type of the value
Initializes a new instance of the class.
Adds a new item to the be stored
the item category
the item name
the item value
Clears all items from the dictionary
Checks whether the specified category exists
the category to look for
Returns true if the category exists
Checks whether an item exists
the category of the item
the name of the item
Returns true if the item exists
Deletes a category from the dictionary
the category to delete
Deletes an item from the dictionary
the category of the item to delete
the name of the item to delete
Gets all items from the dictionary
`2[][].
Gets an item from the dictionary
the category of the item to get
the name of the item to get
An Item
Gets a list of all categories in the dictionary
An array of all categories.
Get all items names in a category
the category to retrieve item names from
An array of all keys in a category.
Gets all items within a category
the category to retrieve items from
An array of all items in a category
Defines a two level list structure
the type of the key
the type of the value
Initializes a new instance of the class.
Adds a new item to the list
the category to access the value
the item value
Clears all items from the list
Checks whether the key exists
the key to look for
Returns true if the key exists
Checks whether an item exists
the category to look for
the value to look for
Returns true if the item exists
Deletes a category
the category to delete
Deletes an item from the list
the category of the item to delete
the item to delete
Gets a list of all categories
An array of the categories.
Gets a list of values for a category
the category to get items for
An array of values for a category.
Used in place of an unrecognizable object type
Handles the loading of typed attributes from an Object.
The type of attribute to load.
Initializes a new instance of the class.
The custom attribute provider.
Gets a value indicating whether any attributes were found.
true if attributes were found; otherwise, false.
Gets a single attribute of the generic type.
An attribute of the specified type.
Gets an array of attributes of the generic type.
An array of attributes of the specified type.
Specifies a link between two parameter object
Initializes a new instance of the class.
The child id.
The parent id.
Gets the child parameter.
The child parameter.
Gets the parent parameter.
The parent parameter.
HandleCollection class. Simple wrapper class for a List of Handles
Class RandomStringGenerator
Prevents a default instance of the class from being created.
Generates a random string with the specified length
the length of the string to generate
System.String.
Class TypeHelper
Converts a type into a user friendly string
Type to convert
User friendly string
Checks whether a type is compatible with another type
the type that should be checked for compatibility
the type that should be compared to
true if [is type compatible] [the specified from type]; otherwise, false.
Checks whether the type inherits or implements the base type
the type to check
the base interface or class
true if [is sub type] [the specified type]; otherwise, false.
type
or
baseType
Generates a default value for the specified data type.
Type of the data to create a value for.
A value of the specified type.
Checks whether the given type is a numeric type.
True if the given type is numeric, false otherwise.
Specifies that the property or class can be expanded into sub-properties using a property editor.
Represents a component within Designer that should be included in the saving of the project.
Gets or sets the name of this component.
The name of the component.
Gets or sets the parent of this component.
The parent container of this component.
Represents a component within the application that should be included within the project data that can contain other sub-components.
Gets a list of any sub-components belonging to this component.
A collection of sub-components.
Determines whether this instance can contain the specified child type.
Type of the child.
Adds a new child component, or replaces an existing component with the same name.
The component to add.
The name to use for the component.
Removes a child component from this container.
The component to remove.
Represents a top level project component within the project. All project components are children of a root component
Typically implemented by the Application services.
Occurs when the project component starts unloading its components.
Occurs when the project component finishes unloading its components.
Occurs when the project component starts loading its components.
Occurs when the project component finishes loading its components.
Applies a new project content configuration for this component to load.
The content that this component should apply.
Interface that represents a Rectangle.
Gets or sets the rotation.
The rotation in degrees.
Gets or sets the width of the element.
The width.
Gets or sets the height of the element.
The height.
Gets or sets the X position of the element.
Gets or sets the Y position of the element.
Moves the element by the and .
Amount to move on the X-axis
Amount to move on the Y-axis
Gets the rotation center X coordinate of the rectangle.
Gets the rotation center Y coordinate of the rectangle.
The key to locate.
True if the key exists.
Null if ket does not exist
Adds the specified key and value.
The key of the element to add. If the key alreay exists, its is overwritten.
The value of the element to add. The value can be null for reference types.
Interface for Designer components that have sub components.
Occurs when the object subcomponents have been modified.
Gets the subcomponents of the object
A container object that represents the data for a single object.
Initializes a new instance of the class.
Gets or sets the content path.
The content path.
Gets or sets the type of data contained within this object.
The type id of the content.
Gets or sets the content that represents a object.
The content object.
This is typically a Dictionary.
Gets a collection of sub content that represent the children of this instance
A list of children belonging to this instance.
Returns a string that represents the current object.
IFunction that wraps a basic delegate function
Initializes a new instance of the class.
The owner of the function.
The basic delegate.
The name of the function.
The obsolete message.
Gets an array of function arguments.
The arguments.
The function arguments.
Gets a value indicating whether this instance can execute.
true if this instance can execute; otherwise, false.
Gets any information associated with the function.
The information message for this function.
Gets a value indicating whether this instance is obsolete.
true if this instance is obsolete; otherwise, false.
Gets the owner of this instance.
The owner.
Gets the references required for this function.
The references.
Gets the return type of this function.
The return type.
Execute the function with a set of arguments.
an array of values to be used as the function parameters.
The function return value.
A simple descriptor of a IFunction object
Initializes a new instance of the class.
Initializes a new instance of the class.
The func.
Gets the name.
The name.
Gets the arguments.
The arguments.
Gets the return type of the function.
The return type of the function.
Gets or sets the short type name.
The short type name.
Gets a value indicating whether this instance is obsolete.
true if this instance is obsolete; otherwise, false.
Gets the information.
The information.
A simple descriptor of a IFunction object
Initializes a new instance of the class.
The function descriptor.
The mode.
Gets the Descriptor.
The descriptor.
Gets the mode.
The mode.
Defines the interface for any published Designer functions
Gets a value indicating whether this instance is obsolete.
true if this instance is obsolete; otherwise, false.
Gets any information associated with the function.
The information message for this function.
Gets a value indicating whether this instance can execute.
true if this instance can execute; otherwise, false.
Gets the return type of this function.
The return type.
Gets an array of function arguments.
The function arguments.
Gets the owner of this instance.
The owner.
Execute the function with a set of arguments.
an array of values to be used as the function parameters.
The function return value.
Interface for the service that manages all published functions
Occurs when a function changes.
Gets all the published functions.
The published functions.
Adds a new function.
The function to add.
Refresh a function.
The function to refresh.
Executes a function
The function to execute
Removes the function.
The function handle.
true if a function was found with the given handle and has been successufully removed. false otherwise.
Removes the functions owned by the specified component.
The owner.
Creates the function proxy to access the specified function.
Name of the function.
A new function proxy.
The method must be called to prevent memory leak.
Determines whether the function with the specified name is accessible from the given Zone.
Name of the function.
The Zone.
A proxy object used to access a function.
Occurs when the proxy becomes connected to the function.
Occurs when the proxy becomes disconnected from the function.
Gets a value indicating whether this instance is connected.
true if this instance is connected; otherwise, false.
Gets the return type of the function.
The return type.
Gets the arguments of the underlying function.
The arguments.
Gets or sets the underlying function.
The source function.
Gets or sets the source handle.
The source handle.
Disconnects this instance.
This must be called when this instance is no longer used or a memory leak could occur.
Executes the function using an array of objects as parameters
an array of values to be used a arguments to the function
Function return value.
Executes the function using an array of objects as parameters
a parameter array of values to be used a arguments to the function
Function return value.
Class PlaceHolderFunction
Initializes a new instance of the class.
The owner.
The arguments.
Type of the return.
Gets an array of function arguments.
The arguments.
The function arguments.
Gets a value indicating whether this instance can execute.
true if this instance can execute; otherwise, false.
Gets any information associated with the function.
The information message for this function.
Gets a value indicating whether this instance is obsolete.
true if this instance is obsolete; otherwise, false.
Gets the owner of this instance.
The owner.
Gets the references required for this function.
The references.
Gets the return type of this function.
The return type.
Execute the function with a set of arguments.
an array of values to be used as the function parameters.
The function return value.
Calling this function does nothing.
A Function object that redirects to another IFunction object
Creates a new instance of the RedirectFunction
the function to redirect to
Gets an array of function arguments.
The arguments.
The function arguments.
Gets a value indicating whether this instance can execute.
true if this instance can execute; otherwise, false.
Gets any information associated with the function.
The information message for this function.
Gets a value indicating whether this instance is obsolete.
true if this instance is obsolete; otherwise, false.
Gets the owner of this instance.
The owner.
Gets the return type of this function.
The return type.
Execute the function with a set of arguments.
an array of values to be used as the function parameters.
The function return value.
Contains meta-data information for a single argument in a designer function.
Initializes a new instance of the class.
Initializes a new instance of the class with a name and data type.
The argument name.
The argument data type.
Initializes a new instance of the class with a ParameterInfo object.
The parameter information.
Gets or sets the current name of the argument
The argument name.
Gets or sets the data type of the argument
The argument data type.
Gets or sets the argument type by string. This is used for serialization purposes.
The string representation of the type..
Gets or sets a value indicating whether this argument is optional.
true if this instance is optional; otherwise, false.
Cognex Internal Use Only.
The appropriate type editor identifier.
The appropriate type editor options.
The base interface for all Designer components. All objects that are registered within Designer must implement this interface.
Gets or sets the handle for this instance that stores information about where this object is located in the Designer register.
a handle object containing information about the location of this component.
This method is called once this instance has been registered within the Designer register.
Interface used by designer to initialize a plugin dll.
Used in conjunction with the assembly Initialization attribute.
Runs any initialization routines required for the entire plugin dll.
Returns true if the initialization was successful and should be loaded into Designer.
Implement any required initialization or pre-requisite checks within this method.
Provides data for a component rename event.
Initializes a new instance of the class.
The previous name of the component.
The new name of the component.
Gets the new name of the component.
The new name of the component.
Gets the previous name of the component.
The previous name of the component.
Specifies an order for a class, property, method or field to be used when displaying in a list.
Initializes a new instance of the class with a specific order.
The order position of the target.
Gets the order position of this attribute.
An integer order position.
Defines the alias which is used for the intellisense of a given script language.
Initializes a new instance of the class.
The language identifier.
The alias.
Gets the language identifier.
Gets the alias.
Provides strongly typed access to a specific component within the Designer register.
The expected type of the component.
Initializes a new instance of the class.
Occurs when the targeted component becomes available.
Occurs when the targeted component becomes unavailable.
Event that occurs when the handle name has been changed
Gets or sets the address of the requested component within the Designer register.
a string containing the full path of the component.
Gets a value indicating whether this instance has a valid connection to the requested component.
true if this instance is connected; otherwise, false.
Gets the requested component instance.
an IApplicationComponent instance.
This is used to provide strongly typed access the requested component.
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
2
Provides application trace logging functionality.
Gets all errors that occurred during the application startup.
a list of errors that occurred during startup.
Gets a list of errors that occurred during the last save.
A list of errors from the last save.
Formats a path for navigation within Designer.
The Designer component path.
A uri representing the Designer path.
Logs an error that occurred during application startup.
The error message text.
The exception detail.
The error group text.
Writes an info level message to the current application log.
The message text to write.
Writes an arbitrary level message to the current application log.
The message text to write.
The log level (which differs between products).
Writes an info exception to the current application log.
The message text.
The exception detail.
This is the same as the $System.Log.WriteException method.
Marks the property as a DotField
TagExtender static class. Provides methods for extending the default functionality of Memory Tags
Gets the extensions.
TagExtension[].
Gets the tags with extension.
The extension.
IMemoryTag[][].
Gets the extension properties.
State of the tag.
TagExtensionObject.
Registers the extension property.
The extension.
Defines a Tag Extension that can be used to provide extra options and functionality to tags
Initializes a new instance of the class.
The name.
Gets the fields.
The fields.
Gets the name.
The name.
Returns whether the extension is applicable to a give TagState
The tag state.
true if the extension is applicable, false otherwise
Returns whether the extension is applicable to all TagState
This value affects whether the extensions shows up in the Tag Manager or the Properties Tool Window
Adds the field.
The field.
Class TagExtensionField
Gets or sets the category.
The category.
Gets or sets the order.
The order.
Gets or sets the name.
The name.
Gets or sets the type of the data.
The type of the data.
Gets or sets the default value.
The default value.
Gets or sets the parent tag extension that this field belongs to.
The parent extension.
Gets the full name including the parent extension path
The full name of the extension field.
Class TagExtensionObject
Initializes a new instance of the class.
The tag extension.
Occures when property list has been changed.
Gets an array of dynamically created properties.
An array of properties.
Class TagExtensionProperty
Initializes a new instance of the class.
The extension.
The tag extension field.
The source tag.
Occurs when child properties are changed.
Occurs when property value is changed.
Occurs when property display name is changed.
Occurs when property read only is changed.
Gets the category that the property belongs to.
The category.
Gets the description for this property.
The description.
Gets all the child properties of this instance.
The child properties.
Gets the value of this property when in development mode.
The value while in development mode.
Gets the user display name of this property.
The display name.
Gets the editor options that are used to configure the editor.
The editor options.
Gets the editor type used to edit this property.
The editor type.
Gets the full name.
The full name.
Gets a value indicating whether this instance is bindable.
true if this instance is bindable; otherwise, false.
Gets a value indicating whether this instance is editable.
true if this instance is editable; otherwise, false.
Gets a value indicating whether this instance is expandable.
true if this instance is expandable; otherwise, false.
Gets a value indicating whether this instance is read only.
true if this instance is read only; otherwise, false.
Gets the name of this property.
The name.
Gets the order of the property in the specified category.
The order in the specified category
Gets the owner of this property.
The owner.
Gets or sets the parent property.
The parent.
Gets the path to access this property.
The path.
Gets the data type of the property.
The type.
Gets or sets the value of the property.
The value.
Gets a specific child property of this instance.
The child property.
Interface IMemoryTag
Gets the address.
The address.
Gets the type of the data.
The type of the data.
Gets a value indicating whether this instance is read only.
true if this instance is read only; otherwise, false.
Gets the path.
The path.
Gets the source of this instance
The source.
Gets the value of the specified tag extension field.
The extension field to get the value for.
The value of the tag extension field
Sets a new value for the tag extension field on this instance.
The extension field to set the value for.
The new value to set.
Interface IMemoryTagService
Occurs when [tags modified].
Gets the extension tags.
The extension.
IMemoryTag[][].
IMemoryTagSource interface provides
Occurs when [high priority value changed].
Occurs when [low priority value changed].
Gets a value indicating whether this instance is connected.
true if this instance is connected; otherwise, false.
Gets or sets the owner.
The owner.
Gets the value.
System.Object.
Sets the value.
The value.
Interface to the TagManager service. Provides generic data binding and subscription functionality
Occurs when tags change.
Gets a list of available Tags.
Adds a new tag into the tag manager.
The tag to register.
Option regarding tag creation: create "dotfield" tags or not. By default "dotfield" tags are created.
Removes an existing tag from collection
name of tag to remove
Removes an existing tag from collection
The ptr of the tag to remove.
Removes an existing tag from collection
The handle of the tag to remove.
Removes all tags owned by the specified component
The owner of the tags to remove.
Subscribes to a tag
If no tag exists, a disconnected proxy will be returned
Path of tag to subscribe to
A proxy connection to the Tag
A common base type for ITag objects
Initializes a new instance of the class.
Initializes a new instance of the class.
The owner.
Event that occurs when the tag data is no longer available
High priority event that occurs when the tag value changes
Use for higher priority events (Communications). Do not update UI on this event
Low priority event that occurs when the tag value changes
Should be used for user-interface updates
Gets or sets the category of the tag.
The category.
Gets a value indicating whether this instance is connected.
true if this instance is connected; otherwise, false.
Gets a value indicating whether this instance is read only.
true if this instance is read only; otherwise, false.
Gets a value indicating whether this tag is obsolete.
true if this tag is obsolete; otherwise, false.
Gets information about the obsolete nature of this tag.
The obsolete information.
Normally a message on what to replace the tag with.
Gets the owner of this tag.
The owner.
Gets the data type of the tag.
The data type of the tag.
Creates a proxy that can be used to access this instance.
A new tag proxy object.
Gets the value of the tag.
The current value of the tag.
Sets the value of the tag.
The value to set.
Gets the data type of this tag.
Type.
Gets whether this instance is connected
true if this instance is connected; otherwise, false.
Gets whether this instance is read only.
true if this instance is read only; otherwise, false.
Sets the owner\parent of the tag.
The value to set.
Gets the tag value.
The current tag value
Sets the current tag value.
The value to set.
Raises the a new value change event.
The value.
Raises the low priorty value change.
The value.
Raises the high priorty value change.
The value.
Defines an array of tags that can be added and removed from
Initializes a new instance of the class.
The owner of the tag array.
The name of the tag array.
The type.
Initializes a new instance of the class.
The owner of the tag array.
The name of the tag array.
if set to true the tags will be read only.
The type.
Occurs when [tag value changed].
Gets or sets a value indicating whether tag updates should be disabled
true if tag updates are disabled; otherwise, false.
Gets or sets a value indicating whether tag publishing should be disabled.
true if tag publishing is disabled; otherwise, false.
Gets or sets the element at the specified index.
The item.
is not a valid index in the .
The property is set and the is read-only.
The element at the specified index.
Gets or sets the type.
The type.
Adds the range.
The range.
Gets the name of the array.
The name.
Gets the owner of the array.
The owner.
Adds the tag.
The index.
Deletes the tag.
The index.
Gets the tag count.
System.Int32.
Raises the event with the provided arguments.
Arguments of the event being raised.
Sets the tag value.
The index.
The value.
Provides an interface to an ITag object.
Event that occurs when the proxy is connected to a Tag
Event that occurs when the proxy is disconnected from the Tag
High priority event that occurs when the tag value changes
Low priority event that occurs when the tag value changes
Gets or sets the source handle.
The source handle.
Gets a value indicating whether this instance is connected.
true if this instance is connected; otherwise, false.
Gets a value indicating whether this instance is read only.
true if this instance is read only; otherwise, false.
Gets or sets the source tag.
The source tag.
Gets the data type of the underlying tag.
The type.
Gets or sets the value of the underlying tag.
The value.
Manages the tag proxies for a single tag
Initializes a new instance of the class.
Adds the proxy.
The proxy.
Connects the proxies to the specified source.
The source.
Disconnects all the proxies.
Class TagsChangedEventArgs
Initializes a new instance of the class.
The tag.
The mode.
Gets the mode.
The mode.
Gets the tag.
The tag.
A tag which the current value is managed by the user.
Initializes a new instance of the class.
The owner.
Type of the data.
if set to true [is read only].
Updates the value.
The value.
Gets the data type of this tag.
Type.
Gets whether this instance is connected
true if this instance is connected; otherwise, false.
Gets whether this instance is read only.
true if this instance is read only; otherwise, false.
Gets the tag value.
The current tag value
Sets the current tag value.
The value to set.
A tag that provides access to either the comment or name of the parent tag.
Initializes a new instance of the class.
The parent tag.
Type of the dot field.
Event that occurs when the tag data is no longer available
High priority event that occurs when the tag value changes
Use for higher priority events (Communications). Do not update UI on this event
Low priority event that occurs when the tag value changes
Should be used for user-interface updates
Gets or sets the category of the tag.
The category.
Gets the data type of the tag.
The data type of the tag.
Gets a value indicating whether this instance is connected.
true if this instance is connected; otherwise, false.
Gets a value indicating whether this instance is read only.
true if this instance is read only; otherwise, false.
Gets a value indicating whether this tag is obsolete.
true if this tag is obsolete; otherwise, false.
Gets information about the obsolete nature of this tag.
The obsolete information.
Normally a message on what to replace the tag with.
Gets the owner of this tag.
The owner.
Creates a proxy that can be used to access this instance.
A new tag proxy object.
Gets the value of the tag.
The current value of the tag.
Sets the value of the tag.
The value to set.
Dot Fields are Read-Only
Enum DotFieldType
The name
A tag that provides access to an object property.
Initializes a new instance of the class.
The object to access.
The path to the property.
Initializes a new instance of the class.
The custom property.
Event that occurs when the tag data is no longer available
High priority event that occurs when the tag value changes
Use for higher priority events (Communications). Do not update UI on this event
Low priority event that occurs when the tag value changes
Should be used for user-interface updates
Gets or sets the category of the tag.
The category.
Gets the display name.
The display name.
Gets a value indicating whether this instance is connected.
true if this instance is connected; otherwise, false.
Gets a value indicating whether this instance is read only.
true if this instance is read only; otherwise, false.
Gets a value indicating whether this tag is obsolete.
true if this tag is obsolete; otherwise, false.
Gets information about the obsolete nature of this tag.
The obsolete information.
Normally a message on what to replace the tag with.
Gets the owner of this tag.
The owner.
Gets the data type of the tag.
The data type of the tag.
Creates a proxy that can be used to access this instance.
A new tag proxy object.
Gets the value of the tag.
The current value of the tag.
Sets the value of the tag.
The value to set.
Sets the owner.
The owner.
Provides the functionality to access a single item of data.
Event that occurs when the data is no longer accessible.
High priority event that occurs when the tag value changes
Use for higher priority events (i.e. Communications). Do not update UI on this event
Low priority event that occurs when the tag value changes
Should be used for user-interface updates
Gets or sets the category of the tag.
The tag category.
Gets the expected data type of the tag.
The tag data type.
Gets the component that owns this tag instance.
The IApplicationComponent owner.
Gets a value indicating whether this tag is read only.
true if this instance is read only; otherwise, false.
Read only tags can not be written to.
Gets a value indicating whether the data belonging to this tag is available and connected.
true if the tag value is connected; otherwise, false.
Calling the or method when this value is false may result in an exception.
Gets a value indicating whether this tag is obsolete and should not be used.
true if this tag is obsolete and should not be used; otherwise, false.
The project verification tool will detect references to obsolete tags.
Gets information about the obsolete nature of this tag.
The obsolete information.
This is usually a message on what to replace the tag with.
Creates a new proxy object that can be used to access this tag.
A new tag proxy object.
Sets the value of this tag.
The new value to set.
Gets the current value of this tag.
The current value of this tag.
A proxy interface for accessing ITag objects.
Occurs when the source ITag object becomes available to be accessed.
Occurs when the source ITag object is no longer present or available to be accessed.
Occurs when the source tag's high priority value changed event occurs.
Occurs when the source tag's low priority value changed event occurs.
Gets or sets the value of the underlying tag.
The underlying tag's value.
Gets the expected data type of the underlying tag.
The data type.
Gets a value indicating whether this tag is read only.
true if this tag is read only; otherwise, false.
Writing to the property when this is true will throw an exception.
Gets a value indicating whether this instance is connected and the underlying tag data is available.
true if this instance is connected; otherwise, false.
Gets or sets the source where this instance's data is being retrieved from.
The source ITag object.
Gets or sets the handle belonging to the ITag where the data should be retrieved from.
A handle belonging to an ITag object.
An option to disable "dotfield" tag creation. E.g.: when adding MyTag whether or not automatically create MyTag.Name also.
Represents the location of a potential data field on a device.
Used by the IBrowsableObject interface to provide lists of available data for connected devices.
Initializes a new instance of the class with a specified name and path.
The short display name for the address.
The full path to access the data on the device.
Gets the full path required to access this data on the device.
The string path.
Gets the short display name for this instance.
The string name.
Defines the types of categories that a tag can belong to.
The tag does not belong to a particular category.
The tag belongs to a designer component.
The tag is a sub-tag of an existing tag.
Provides information about designer tag value changes.
Initializes a new instance of the class with a new value.
The new current value.
Gets the new current value.
The new value.
Specifies a link between two class parameters.
The childParameter and parentParameter strings should match the id of a Parameter on the same class.
Creates a new instance of the attribute
the id of the child parameter.
the id of the parent parameter.
Gets an object containing information about the link between parameters.
Specifies that the a property can be bound to.
Used by the HMI to animate control properties.
Specifies that the property should be editable through the Designer property editor.
Initializes a new instance of the class.
The order that the property should be displayed in the property editor.
Gets the order that the property should be displayed.
The specified order for the property.
Specifies a new parameter for a class.
A class can have multiple parameters. This is primarily used for Designer devices and component.
Initializes a new instance of the class using localized strings.
The auto-generated resource class that contains the string to
lookup for localized string.
The index that defines the position of the parameter within a list.
The string identifier.
The resource key used to lookup the display name.
The data type.
The default value.
Initializes a new instance of the class.
The index that defines the position of the parameter within a list.
The string identifier.
The display name text.
The data type.
The default value.
Initializes a new instance of the class using localized strings.
The index that defines the position of the parameter within a list.
The string identifier.
The resource key used to lookup the display name.
The data type.
The default value.
the name of the type editor used to edit this parameter
a param array of options passed in to the type editor
Initializes a new instance of the class.
The index that defines the position of the parameter within a list.
The string identifier.
The display name text.
The data type.
The default value.
the name of the type editor used to edit this parameter
a param array of options passed in to the type editor
Gets a parameter object that contains all attribute inputs.
The parameter object.
Specifies that the target property or method should be automatically registered in designer as a $ function or tag.
Is the member published?
Get tag creation option
Specifies that the target property should be serialized by the designer application as part of the project configuration.
Initializes a new instance of the class.
Initializes a new instance of the class with a specific serializer
The string identifier for the serializer to use.
Gets the identifier of the serializer to user for serialization.
The string identifier for the serializer.
Specifies a specific type editor to be used when editing the property, class or parameter.
The default type editor category to use.
Initializes a new instance of the class with a specific type editor.
name of the type editor to use for the target.
a list of parameters to pass into the type editor.
Initializes a new instance of the class with a specific type editor.
the editor category.
name of the type editor to use for the target.
a list of parameters to pass into the type editor.
Cognex Internal Use Only.
the category text.
Gets the name of the editor that should be used to edit the target.
The text id of the editor.
Gets the set of parameters passed into the type editor.
an array of object parameters.
an array of object parameters.
Stores information about the name and location of an object within the Designer register.
Event that occurs when the handle proxy detects that the targetted handle has become available
Event that occurs when the handle proxy detects that the targetted handle has become unavailable
Event that occurs when the handle name has been changed
Occurs when a property value changes.
Gets a value indicating whether this instance is connected to an active handle instance.
true if this instance is connected; otherwise, false.
Gets a unique pointer that identifies the handle within the Designer register.
an integer containing this handle's unique pointer.
Gets the short name (Not including parent handle name) of this instance .
a string containing the short name of this handle.
Gets the full name (including parent name) for this instance.
a string containing the full path to this handle.
Do not set this property.
Gets all the child handles of this handle.
a collection of handles that are children to this instance.
Gets the parent of this handle.
a handle of the parent.
Do not set this property.
Gets the Zone of the component associated with this instance.
Determines whether the component associated with this instance is accessible from the specified zone.
The zone.
Cognex internal use only.
Cognex internal use only.
Cognex internal use only.
Disconnects this proxy instance from an actual registered handle.
Gets the component that owns this handle from the Designer register.
an IApplicationComponent that owns this handle.
Cognex internal use only.
Called when the handle name is changed.
a string containing the previous full name
a string containing the new full name
Raises the connected event on this handle.
Raises the disconnected event on this handle.
Raises the event.
Gets the fully qualified name of a child handle of a parent object with the given short name.
Gets the fully qualified name of a child handle of a parent object with the given short name.
Handles parent name changed.
Represents a setup parameter for a designer component.
This is returned by the attribute.
Initializes a new instance of the class.
Initializes a new instance of the class with default values
The index that defines the position of the parameter within a list.
The string identifier.
The display name text.
The data type.
The default value.
Gets or sets the display name shown to users.
The display name text.
Gets or sets the a unique string identifier for this instance.
The string identifier.
Must be unique within a collection of parameters.
Gets or sets the index used to automatically order this parameter within a list.
The index.
Decimal places can be used to group parameters i.e. 3.0 and 3.1 are in the same group
Gets or sets the expected data type of the parameter.
The expected data type.
Gets or sets the default value of the parameter.
The current default value.
Gets or sets the name of the editor that is used to provide a typeeditor for this parameter.
The name of the editor.
Gets or sets an array of options that are passed into the type editor used to edit this parameter.
an array of editor options.
Defines the a short type name string to represent a .Net type
Initialize the TypeName attribute with a short type name for the decorated type.
Gets the short TypeName for the decorated type.
A strongly-typed resource class, for looking up localized strings, etc.
Returns the cached ResourceManager instance used by this class.
Overrides the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
Looks up a localized string similar to A name may only use a combination of the following characters: _ A-Z a-z 0-9 {0}The first character must be a letter or an underscore..
Looks up a localized string similar to A segment name matches a reserved word: .
Looks up a localized string similar to Clamps the specified value to the specified minimum and maximum range..
Looks up a localized string similar to Concatenates the string representation of the specified arguments (excluding the first) using the first item as separator between each member..
Looks up a localized string similar to Concatenates the string representation of the specified arguments..
Looks up a localized string similar to Converts all values to System.Double and returns the average of the numbers..
Looks up a localized string similar to Converts all values to System.Double and returns the product of the numbers. Returns 1.0 for empty argument list according to standard definition for empty product..
Looks up a localized string similar to Converts all values to System.Double and returns the sum of the numbers. Returns 0 for empty argument list..
Looks up a localized string similar to Could not authenticate (unknown error)..
Looks up a localized string similar to Could not connect to Controller.
Looks up a localized string similar to Determines whether the specified object is a System.Boolean value..
Looks up a localized string similar to Determines whether the specified object is a System.String value..
Looks up a localized string similar to Determines whether the specified object is a numeric value..
Looks up a localized string similar to Each segment may only use a combination of the following characters: _ A-Z a-z 0-9 {0}The first character of each segment must be a letter or an underscore. Segments must be separated by periods (".")..
Looks up a localized string similar to Empty block cannot be evaluated..
Looks up a localized string similar to Extracts the characters from a string, between two specified indices, and returns the sub string. This method extracts the characters in a string between "start" and "end", not including "end" itself. If "start" is greater than "end", this method will swap the two arguments. If either "start" or "stop" is less than 0, it is treated as if it were 0..
Looks up a localized string similar to Extracts the characters in a string after "start". If "start" is less than 0, it is treated as if it were 0..
Looks up a localized string similar to Gets a string representation of a numeric value with specified number of decimal places..
Looks up a localized string similar to Gets a value indicating whether the argument is null object or not..
Looks up a localized string similar to Gets the name of the type of the given object..
Looks up a localized string similar to Gets the number of characters in the given string..
Looks up a localized string similar to Indicates whether the specified string is null or an empty string..
Looks up a localized string similar to Indicates whether the specified string is null or consists only of white-space characters..
Looks up a localized string similar to Missing argument for unary operator.
Looks up a localized string similar to Missing closing parentheses..
Looks up a localized string similar to Missing first argument of binary operator..
Looks up a localized string similar to Missing list separator..
Looks up a localized string similar to Missing second argument of binary operator.
Looks up a localized string similar to Name cannot be null..
Looks up a localized string similar to Name matches a reserved system component name..
Looks up a localized string similar to Name matches a reserved word: .
Looks up a localized string similar to User could not authenticate and decided to exit the application (not an error)..
Looks up a localized string similar to Removes all leading and trailing white-space characters from the specified string..
Looks up a localized string similar to Replaces the format item in a specified string with the string representation of a corresponding object in the argument list..
Looks up a localized string similar to Represents an empty object reference..
Looks up a localized string similar to Represents a value that is not a number (NaN)..
Looks up a localized string similar to Represents negative infinity..
Looks up a localized string similar to Represents positive infinity..
Looks up a localized string similar to Represents the logical false Boolean value..
Looks up a localized string similar to Represents the logical true Boolean value..
Looks up a localized string similar to Represents the ratio of the circumference of a circle to its diameter, specified by the constant, 𝜋..
Looks up a localized string similar to Represents the smallest positive System.Double value that is greater than zero..
Looks up a localized string similar to Returns a copy of this string converted to lowercase..
Looks up a localized string similar to Returns a copy of this string converted to uppercase..
Looks up a localized string similar to Returns a list containing the given items..
Looks up a localized string similar to Returns an array containing the given items..
Looks up a localized string similar to Returns a new string in which all occurrences of 'oldString' in the 'str' are replaced with 'newString'..
Looks up a localized string similar to Returns a new string in which a specified number of characters in the specified string beginning at a specified position have been deleted..
Looks up a localized string similar to Returns a value indicating that str0 contains str1..
Looks up a localized string similar to Returns e raised to the specified power..
Looks up a localized string similar to Returns the absolute value of the number..
Looks up a localized string similar to Returns the angle whose cosine is the specified number..
Looks up a localized string similar to Returns the angle whose sine is the specified number..
Looks up a localized string similar to Returns the angle whose tangent is the specified number..
Looks up a localized string similar to Returns the argument at the specified position in given array..
Looks up a localized string similar to Returns the argument at the specified position in the argument list. 'index = 0' maps to the second argument..
Looks up a localized string similar to Returns the binary logarithm of the specified number..
Looks up a localized string similar to Returns the cosine of the specified angle..
Looks up a localized string similar to Returns the decimal logarithm of the specified number..
Looks up a localized string similar to Returns the hyperbolic cosine of the specified angle..
Looks up a localized string similar to Returns the hyperbolic sine of the specified angle..
Looks up a localized string similar to Returns the hyperbolic tangent of the specified angle..
Looks up a localized string similar to Returns the integral part of a specified number..
Looks up a localized string similar to Returns the largest integer less than or equal to the number..
Looks up a localized string similar to Returns the largest value from the argument list..
Looks up a localized string similar to Returns the natural logarithm of the specified number..
Looks up a localized string similar to Returns the natural logarithm of the specified number in a specified base..
Looks up a localized string similar to Returns the sine of the specified angle..
Looks up a localized string similar to Returns the smallest integer greater than or equal to it..
Looks up a localized string similar to Returns the smallest value from the argument list..
Looks up a localized string similar to Returns the square root of x..
Looks up a localized string similar to Returns the tangent of the specified angle..
Looks up a localized string similar to Returns the value of the first argument that can be evaluated..
Looks up a localized string similar to Returns the zero-based index of the first argument in the specified array or -1 if it was not found..
Looks up a localized string similar to Returns the zero-based index of the first argument in the remaining argument list or -1 if it was not found..
Looks up a localized string similar to Returns the zero-based index of the first occurrence of str1 string in str0..
Looks up a localized string similar to Returns the zero-based index of the last occurrence of str1 string in str0..
Looks up a localized string similar to Returns true if and only if all arguments evaluate to true..
Looks up a localized string similar to Returns true if and only if any argument evaluates to true..
Looks up a localized string similar to Returns 'trueValue' if 'condition' evaluates to true or 'falseValue' otherwise..
Looks up a localized string similar to Returns x raised to the specified power..
Looks up a localized string similar to Rounds the value to the nearest integer..
Looks up a localized string similar to Sorts values and returns the one (or the average of the two) in the middle..
Looks up a localized string similar to The name is already in use..
Looks up a localized string similar to Too many closing parentheses..
Looks up a localized string similar to Two list separators..
Looks up a localized string similar to Unexpected closing parentheses..