C# Class afeprojectname.luginclassname

Inheritance: IZooPlugin

Datei anzeigen Open project: mcneel/RhinoCommonTemplatePackage

Public Methods

Method	Description
Address ( ) : string	Returns the address of your company or organization. Use a "\r\n" character combination to separate lines. (e.g. "3670 Woodland Park Avenue North\r\nSeattle, WA 98115")
Country ( ) : string	Returns the country in which your company or organization is located. (e.g. "United States")
Email ( ) : string	Returns an email address that a customer can use to contact you. (e.g. "[email protected]")
Fax ( ) : string	Returns a FAX number that a customer can use to contact you. (e.g. "(206) 545-7321")
FormatErrorMessage ( int messageID, System locale ) : string	Looks up a human-readable, properly localized error message for logging and display purposes.
Organization ( ) : string	Returns the name of your company or organization. (e.g. "Robert McNeel and Associates")
Phone ( ) : string	Returns a phone number that a customer can use to contact you. (e.g. "(206) 545-7000")
ProductTitle ( ) : string	Returns the name, version, and/or type of the product that this plug-in validates. This string will appear in user interfaces were one can choose type type of license to validate.
RhinoPluginId ( ) : System.Guid	Returns your unique identifier, or PlugInId, of your Rhino plug-in. If this does not return the same guid as your Rhino plug-in, then it will not be able to obtain a license from the Zoo.
ValidateProductKey ( string productKey, ZooPluginLicenseData &licenseData ) : int	Validates a product, or CD, key that was entered into the Zoo administrator console, and returns license data. This data will, in turn, be serialized, maintained, and distributed by the Zoo.
ValidateProductKeyUI ( string productKey, string &validatedKey ) : int	We do not need to show any UI. If we wanted to, we could show it here before the key is passed over to ValidateProductKey.
Web ( ) : string	Returns the web address or url of your company or organization. (e.g. "http://www.rhino3d.com")
ZooPluginId ( ) : System.Guid	Returns a guid that uniquely identifies this Zoo plug-in class.

Private Methods

Method	Description
Scramble ( string input ) : string	Randomizes character positions in string

Method Details

Address() public method

Returns the address of your company or organization. Use a "\r\n" character combination to separate lines. (e.g. "3670 Woodland Park Avenue North\r\nSeattle, WA 98115")

public Address ( ) : string
return	string

Country() public method

Returns the country in which your company or organization is located. (e.g. "United States")

public Country ( ) : string
return	string

Email() public method

Returns an email address that a customer can use to contact you. (e.g. "[email protected]")

public Email ( ) : string
return	string

Fax() public method

Returns a FAX number that a customer can use to contact you. (e.g. "(206) 545-7321")

public Fax ( ) : string
return	string

FormatErrorMessage() public method

Looks up a human-readable, properly localized error message for logging and display purposes.

public FormatErrorMessage ( int messageID, System locale ) : string
messageID	int	/// MessageID is a plug-in specific ID that is returned when ValidateProductKey /// fails to validate the key. ///
locale	System	/// The CultureInfo associated with the currently running process; use this info /// to localize your error messages appropriately. ///
return	string

Organization() public method

Returns the name of your company or organization. (e.g. "Robert McNeel and Associates")

public Organization ( ) : string
return	string

Phone() public method

Returns a phone number that a customer can use to contact you. (e.g. "(206) 545-7000")

public Phone ( ) : string
return	string

ProductTitle() public method

Returns the name, version, and/or type of the product that this plug-in validates. This string will appear in user interfaces were one can choose type type of license to validate.

public ProductTitle ( ) : string
return	string

RhinoPluginId() public method

Returns your unique identifier, or PlugInId, of your Rhino plug-in. If this does not return the same guid as your Rhino plug-in, then it will not be able to obtain a license from the Zoo.

public RhinoPluginId ( ) : System.Guid
return	System.Guid

ValidateProductKey() public method

Validates a product, or CD, key that was entered into the Zoo administrator console, and returns license data. This data will, in turn, be serialized, maintained, and distributed by the Zoo.

public ValidateProductKey ( string productKey, ZooPluginLicenseData &licenseData ) : int
productKey	string	/// The product, or CD, key to validate. This is the raw, unmodified product key /// string as entered into the Zoo Administrator console. ///
licenseData	ZooPluginLicenseData	/// If productKey represents a valid license for your product, then licenseData /// should be filled in with information about the license. ///
return	int

ValidateProductKeyUI() public method

We do not need to show any UI. If we wanted to, we could show it here before the key is passed over to ValidateProductKey.

public ValidateProductKeyUI ( string productKey, string &validatedKey ) : int
productKey	string	The product, or CD, key to validate. /// This is the raw, unmodified product key string as entered into the /// Zoo Administrator console.
validatedKey	string	The modified productKey string. /// Again, in most cases you will set validatedKey equal productKey. /// This value will be passed to ValidateProductKey().
return	int

Web() public method

Returns the web address or url of your company or organization. (e.g. "http://www.rhino3d.com")

public Web ( ) : string
return	string

ZooPluginId() public method

Returns a guid that uniquely identifies this Zoo plug-in class.

public ZooPluginId ( ) : System.Guid
return	System.Guid