Class Appli.CatalogSummary
Provides an access to a catalog data without an ability to modify it, thus excluding perfomance overhead needed to convert a catalog to its editable representation.
Implements
Inherited Members
Namespace: KD.SDK2
Assembly: KD.SDK2.dll
Syntax
public class Appli.CatalogSummary : IEquatable<Appli.CatalogSummary>
Examples
// This script shows how to obtain a detailed description for one block
// of "@K2.cat"" catalog on a named section
var catalogSummary = appli.GetCatalogByFilename("@K2");
foreach (var section in catalogSummary.GetSections(skipHidden: true))
{
if (section.Name == "Eléments bas < 4U")
{
foreach (var block in section.GetBlocks())
{
if (block.Name == "Bas 3U 1P")
{
Console.WriteLine("Description : " + block.Description);
Console.WriteLine("Code : " + block.Code);
var articles = block.GetArticles();
Console.WriteLine($"{block.Name} has nb article(s): {articles.Count}");
foreach (var article in articles)
Console.WriteLine($"\tDepth : {article.Depth} Height: { article.Height} Reference : {article.Reference}");
break;
}
}
break;
}
}
Properties
Name | Description |
---|---|
After |
After sales code of the catalog. |
Base |
Filename of the catalog's base catalog. |
Base |
Last write time of the catalog's base catalog (as it was at the moment when the base catalog contents was embedded inside the catalog). |
Code | Code of the catalog (8 characters maximum, useful for statistics in particular). |
Creation |
Creation time of the catalog. |
Currency | Code of the currency in which purchase and selling prices are defined in the catalog. |
Custom |
Provides access to the catalogs's custom data area dedicated wholely to the application extensions. |
Filename | Filename of the catalog, without path and extension (8 characters maximum). |
Filename |
Filename of the catalog, with complete path and extension. |
Has |
Indicates whether the catalog contains purchase prices. |
Has |
Indicates whether the catalog contains purchase prices. |
Is |
Indicates whether the catalog is a base catalog. |
Is |
Indicates whether the catalog is complementary. |
Is |
Indicates whether the catalog validity start date check is enabled. |
Is |
Indicates whether the catalog validity end date check is enabled. |
Is |
Indicates whether prices in the catalog include VAT. |
Language |
Language code of the catalog (also known as working language). |
Last |
Time of the last save of the catalog. |
Name | Name of the catalogue displayed in the KitchenDraw planning window (max 30 characters). |
Pack |
The pack code which the catalog belongs to. |
Price |
Price configuration used in the catalog (e.g. selling prices only, or purchase and selling prices, or purchase prices only). |
Sub |
Subtype of the catalog. |
Sub |
Subtype rank of the catalog. |
Type | Type of the catalog. |
Type |
Type rank of the catalog. |
Unit | Measuring unit of the catalog. |
Valid |
Catalog validity start date. |
Valid |
Catalog validity end date. |
Vat |
VAT rate included in the catalog prices, if any is included, 0.0 otherwise. |
Methods
Name | Description |
---|---|
Equals(object) | Determines whether passed object has the same type and value as this one. |
Export |
Exports thumbnail corresponding to a given article as an image file. |
Export |
Exports a resource which has a given filename. |
Export |
Exports a resource which has a given name. |
Get |
Returns the list of AppliCats stored in the catalog. |
Get |
Gets the dimension constraints applied to the key reference in the catalog. |
Get |
Returns the list of families of the catalog. |
Get |
Provides a numeric value that is used to identify an object in hash-based algorithms. |
Get |
Gets a value from arbitrary datafield specified by the infoType parameter. |
Get |
Gets a value from arbitrary datafield specified by the infoType parameter. |
Get |
Gets a value from arbitrary datafield specified by the infoType parameter. |
Get |
Gets a value from arbitrary datafield specified by the infoType parameter. |
Get |
Returns the list of blocks of a particular linear type. |
Get |
Returns the list of models of the catalog. |
Get |
Gets contents of resource with a given name as bytes. |
Get |
Gets contents of resource with a given name as text. |
Get |
|
Get |
Returns the list of sections of the catalog. |
Get |
Finds first occurence of a given code in a given catalog table, and returns matching row rank. |
Get |
Returns url of a product detail page bound to the catalog block of the key reference, if any. |
Launch |
Opens an AppliCat from the catalog. |
To |
Returns a string that represents the current object. |
Operators
Name | Description |
---|---|
operator ==(Catalog |
Determines whether two specified instances have the same value. |
operator !=(Catalog |
Determines whether two specified instances have different values. |