Job > Entity Objects > Barcode

Data Matrix Cell Size			☒ Set ☒ Get
DLL Function	int CCI_Return = ScSetEntityDoubleData(string Entity_Name, int Data_ID, double Cell_Size) int CCI_Return = ScGetEntityDoubleData(string Entity_Name, int Data_ID, ref double Cell_Size)
ASCII Function	int CCI_Return = ScCciSetEntityDoubleData(string Entity_Name, int Data_ID, double Cell_Size) double Cell_Size = ScCciGetEntityDoubleData(string Entity_Name, int Data_ID)
Description	Set or get the cell size. Available only if cellmode is enabled.
Entity_Name	Type: string	Unit: none
Entity_Name	Specify the entity to be changed.
Data_ID	Type: int		ID:
	Location: ScComSAMLightClientCtrlFlags
	scComSAMLightClientCtrlDoubleDataIdDataMatrixCellSizeX		72
	The size in x direction.
	scComSAMLightClientCtrlDoubleDataIdDataMatrixCellSizeY		73
	The size in y direction.
Cell_Size	Type: double	Unit: none
Cell_Size	Value between 0 and 1.
CCI_Return	Type: int
CCI_Return	CCI return number, see error list.
Notes	•The size is specified in percents.
C# Example: Set the cell size in X to 80% for the entity "DataMatrix1": int CCI_Return = cci.ScSetEntityDoubleData("DataMatrix1", (int)ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlDoubleDataIdDataMatrixCellSizeX, 80.0);
C# Example: Get the value of the current cell size in x direction for the entity "DataMatrix1": double Cell_Size_X = 0.0; int CCI_Return = cci.ScGetEntityDoubleData("DataMatrix1", (int)ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlDoubleDataIdDataMatrixCellSizeX, ref Cell_Size_X);

Table 139: Data Matrix Cell Size

Data Matrix Distance Between Dots			☐ Set ☒ Get
DLL Function	int CCI_Return = ScGetEntityDoubleData(string Entity_Name, int Data_ID, ref double Distance)
ASCII Function	double Distance = ScCciGetEntityDoubleData(string Entity_Name, int Data_ID)
Description	Get the distance between two points of DataMatrixEx.
Entity_Name	Type: string	Unit: none
Entity_Name	Specify the entity to be changed.
Data_ID	Type: int		ID:
	Location: ScComSAMLightClientCtrlFlags
	scComSAMLightClientCtrlDoubleDataIdDataMatrixDistanceBetweenDots		87
Distance	Type: double	Unit: [mm]
Distance	Value between 0.0 and 1.0.
CCI_Return	Type: int
CCI_Return	CCI return number, see error list.
Notes	-
C# Example: Get the distance between dots for the "DataMatrix1" entity: double Distance_Between_Dots = 0.0; int CCI_Return = cci.ScGetEntityDoubleData("DataMatrix1", (int)ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlDoubleDataIdDataMatrixDistanceBetweenDots, ref Distance_Between_Dots);

Table 140: Data Matrix Distance Between Dots

Data Matrix Encoding			☒ Set ☒ Get
DLL Function	int CCI_Return = ScSetEntityLongData(string Entity_Name, int Data_ID, int Flag) int Flag = ScGetEntityLongData(string Entity_Name, int Data_ID)
ASCII Function	int CCI_Return = ScCciSetEntityLongData(string Entity_Name, int Data_ID, int Flag) int Flag = ScCciGetEntityLongData(string Entity_Name, int Data_ID)
Description	Set or get the encoding type of the DataMatrix object.
Entity_Name	Type: string	Unit: none
Entity_Name	Set or get the Encoding of the Data Matrix.
Data_ID	Type: int		ID:
	Location: ScComSAMLightClientCtrlFlags
	scComSAMLightClientCtrlLongDataIdDataMatrixEncoding		106
Flag	Type: int		Index:
	Location: ScComSAMLightClientCtrlFlags
	scComSAMLightClientCtrlLongDataIdDataMatrixExEncodationAscii		1
	scComSAMLightClientCtrlLongDataIdDataMatrixExEncodationBase256		2
	scComSAMLightClientCtrlLongDataIdDataMatrixExEncodationC40		3
	scComSAMLightClientCtrlLongDataIdDataMatrixExEncodationText		4
	scComSAMLightClientCtrlLongDataIdDataMatrixExEncodationAnsiX12		5
	scComSAMLightClientCtrlLongDataIdDataMatrixExEncodationEdifact		6
CCI_Return	Type: int
CCI_Return	CCI return number, see error list.
Notes	•You can set only one encodation type simultaneously.
C# Example: Change the data matrix encoding of the entity "DataMatrix1" to C40: int encoding:Mode = (int)ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlLongDataIdDataMatrixExEncodationC40; int CCI_Return = cci.ScSetEntityLongData("DataMatrix1", (int)ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlLongDataIdDataMatrixEncoding, encodingMode);
C# Example: Get the current value of the Data Matrix Encoding of the "DataMatrix1" entity: int current:Encoding = cci.ScGetEntityLongData("DataMatrix1", (int)ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlLongDataIdDataMatrixEncoding);

Table 141: Data Matrix Encoding

Data Matrix Ex Flags			☒ Set ☒ Get
DLL Function	int CCI_Return = ScSetEntityLongData(string Entity_Name, int Data_ID, int DM_Ex_Flags) int DM_Ex_Flags = ScGetEntityLongData(string Entity_Name, int Data_ID)
ASCII Function	int CCI_Return = ScCciSetEntityLongData(string Entity_Name, int Data_ID, int DM_Ex_Flags) int DM_Ex_Flags = ScCciGetEntityLongData(string Entity_Name, int Data_ID)
Description	Set or get the checkboxes state at barcode extended settings (availiable only for the data matrix ex barcode type).
Entity_Name	Type: string	Unit: none
Entity_Name	Specify the entity to be changed.
Data_ID	Type: int		ID:
	Location: ScComSAMLightClientCtrlFlags
	scComSAMLightClientCtrlLongDataIdDataMatrixSetSymbolMode		103
	Enable checkboxes.
	scComSAMLightClientCtrlLongDataIdDataMatrixClearSymbolMode		104
	Disable checkboxes.
DM_Ex_Flags	Type: int		Flags:
	Location: ScComSAMLightClientCtrlFlags
	scComSAMLightClientCtrlLongDataIdDataMatrixExSymbolModeRectangle		0x1
	scComSAMLightClientCtrlLongDataIdDataMatrixExSymbolModeAutoSize		0x10000
	scComSAMLightClientCtrlLongDataIdDataMatrixExSymbolModeAutoEncodation		0x20000
	scComSAMLightClientCtrlLongDataIdDataMatrixExSymbolModeDots		0x40000
	scComSAMLightClientCtrlLongDataIdDataMatrixExSymbolModeTilde		0x80000
	scComSAMLightClientCtrlLongDataIdDataMatrixExSymbolModeCells		0x100000
	scComSAMLightClientCtrlLongDataIdDataMatrixExSymbolModeNoFinderCells		0x200000
	scComSAMLightClientCtrlLongDataIdDataMatrixExSymbolModeEllipse		0x400000
	scComSAMLightClientCtrlLongDataIdDataMatrixExSymbolModeTextFreelyEditable		0x800000
CCI_Return	Type: int
CCI_Return	CCI return number, see error list.
Notes	•The Flag value can be a combination of multiple flags. •Unlike other flag handling in CCI, here not all flags are written at once. Only the chosen flags are enabled with SetSymbolMode or disabled with ClearSymbolMode. •Not all flags are compatible with each other. Refer to SAMLight to learn more about flag compatibility.
C# Example: Enable Rectangle and AutoSize of "DataMatrixEx1". Other flags are not changed: int CCI_Return = cci.ScSetEntityLongData( "DataMatrixEx1", ( int )ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlLongDataIdDataMatrixSetSymbolMode, ( int )ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlLongDataIdDataMatrixExSymbolModeRectangle \| ( int )ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlLongDataIdDataMatrixExSymbolModeAutoSize );
C# Example: Disable Rectangle and AutoSize of "DataMatrixEx1". Other flags are not changed: int CCI_Return = cci.ScSetEntityLongData( "DataMatrixEx1", ( int )ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlLongDataIdDataMatrixClearSymbolMode, ( int )ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlLongDataIdDataMatrixExSymbolModeRectangle \| ( int )ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlLongDataIdDataMatrixExSymbolModeAutoSize );
C# Example: Get the current data matrix flags of "DataMatrixEx1": int Flags = cci.ScGetEntityLongData( "DataMatrixEx1", ( int )ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlLongDataIdDataMatrixSetSymbolMode );

Table 142: Data Matrix Ex Flags

Data Matrix Quiet Zone			☒ Set ☒ Get
DLL Function	int CCI_Return = ScSetEntityDoubleData(string Entity_Name, int Data_ID, double Quiet_Zone) int CCI_Return = ScGetEntityDoubleData(string Entity_Name, int Data_ID, ref double Quiet_Zone)
ASCII Function	int CCI_Return = ScCciSetEntityDoubleData(string Entity_Name, int Data_ID, double Quiet_Zone) double Quiet_Zone = ScCciGetEntityDoubleData(string Entity_Name, int Data_ID)
Description	Set or get the quiet zone of a DataMatrixEx. If the checkbox Absolute is activated the quiet zone is given in mm. If you need to set different paramters for X and Y you have to clear the flag scComBarFlagDisableAutoQuietZone with BarcodeClearFlags. If not, the quiet zone is given as a scale factor.
Entity_Name	Type: string	Unit: none
Entity_Name	Specify the entity to be changed.
Data_ID	Type: int		ID:
	Location: ScComSAMLightClientCtrlFlags
	scComSAMLightClientCtrlDoubleDataIdDataMatrixQuietZoneX		81
	The quiet zone in x direction.
	scComSAMLightClientCtrlDoubleDataIdDataMatrixQuietZoneY		82
	The quiet zone in y direction.
Quiet_Zone	Type: double	Unit: none
Quiet_Zone	Value between 0 and 1.
CCI_Return	Type: int
CCI_Return	CCI return number, see error list.
Notes	-
C# Example: Set the quiet zone size in X to 20% for the entity "DataMatrix1": int CCI_Return = cci.ScSetEntityDoubleData( "DataMatrix1", ( int )ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlDoubleDataIdDataMatrixQuietZoneX, 20.0 );
C# Example: Get the value of the current quiet zone in X for the entity "DataMatrix1": double Quiet_Zone_X = 0.0; int CCI_Return = cci.ScGetEntityDoubleData( "DataMatrix1", ( int )ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlDoubleDataIdDataMatrixQuietZoneX, ref Quiet_Zone_X );

Table 143: Data Matrix Quiet Zone

Data Matrix Points per Cell			☒ Set ☒ Get
DLL Function	int CCI_Return = ScSetEntityLongData(string Entity_Name, int Data_ID, int Points_Per_Cell) int Points_Per_Cell = ScGetEntityLongData(string Entity_Name, int Data_ID)
ASCII Function	int CCI_Return = ScCciSetEntityLongData(string Entity_Name, int Data_ID, int Points_Per_Cell) int Points_Per_Cell = ScCciGetEntityLongData(string Entity_Name, int Data_ID)
Description	Set or get the number of points per cell for DataMatrixEx.
Entity_Name	Type: string	Unit: none
Entity_Name	Specify the entity to be changed.
Data_ID	Type: int		ID:
	Location: ScComSAMLightClientCtrlFlags
	scComSAMLightClientCtrlLongDataIdDataMatrixNumberOfDots		124
Points_Per_Cell	Type: int	Unit: none
Points_Per_Cell	Valid values to set are 1, 4, 9, 16, otherwise returns error.
CCI_Return	Type: int
CCI_Return	CCI return number, see error list.
Notes	-
C# Example: Set the number of dots for the entity "DataMatrix1" to 4: int CCI_Return = cci.ScSetEntityLongData("DataMatrix1", (int)ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlLongDataIdDataMatrixNumberOfDots, 4);
C# Example: Get the current number of dots for the entity "DataMatrix": int points_Per_Cell = cci.ScGetEntityLongData("DataMatrix1", (int)ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlLongDataIdDataMatrixNumberOfDots);

Table 144: Data Matrix Points per Cell

Data Matrix Symbol Size			☒ Set ☒ Get
DLL Function	int CCI_Return = ScSetEntityLongData(string Entity_Name, int Data_ID, int Symbol_Size) int Symbol_Size = ScGetEntityLongData(string Entity_Name, int Data_ID)
ASCII Function	int CCI_Return = ScCciSetEntityLongData(string Entity_Name, int Data_ID, int Symbol_Size) int Symbol_Size = ScCciGetEntityLongData(string Entity_Name, int Data_ID)
Description	Set or get the symbols size in the data matrix.
Entity_Name	Type: string	Unit: none
Entity_Name	Specify the entity to be changed.
Data_ID	Type: int		ID:
	Location: ScComSAMLightClientCtrlFlags
	scComSAMLightClientCtrlLongDataIdDataMatrixSymbolSize		105
Symbol_Size	Type: int	Unit: none
Symbol_Size	Parameter corresponds to the sizes in combo box, starting with 1.
CCI_Return	Type: int
CCI_Return	CCI return number, see error list.
Notes	-
C# Example: Set the symbol size of the "DataMatrix1" entity to 8: int CCI_Return = cci.ScSetEntityLongData("DataMatrix1", (int)ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlLongDataIdDataMatrixSymbolSize, 8);
C# Example: Get the value of the symbol size of the entity "DataMatrix1": int symbolSize = cci.ScGetEntityLongData("DataMatrix1", (int)ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlLongDataIdDataMatrixSymbolSize);

Table 145: Data Matrix Symbols Size