KitchenDraw SDK 2
Show / Hide Table of Contents

Method TryGetFamilyFinishClusterFromFamilyAndType

TryGetFamilyFinishClusterFromFamilyAndType(int, string, out Cluster)

Retrieves a cluster of the "Family finishes" table of the catalog by given model and finish type.

Declaration
public bool TryGetFamilyFinishClusterFromFamilyAndType(int familyRank, string finishType, out Catalog.Table.Cluster matchingCluster)
Parameters
Type Name Description
int familyRank

Zero-based rank of the family (can be considered as a row rank of the family of the "Families" table of the catalog).

string finishType

Character string that can be found in "Model finish types" combobox of "Model finishes" table in the MobiScript window. This string is language-dependent (varies according to the application's current language).

Catalog.Table.Cluster matchingCluster

When the method completes, contains the first matching cluster or null if no matching cluster was found.

Returns
Type Description
bool

true if a matching cluster was found, false oterwise.

In this article
Back to top Generated by DocFX