Icon Method

Help > Web Development > Object Reference > Object Reference > ISYSDocument > Icon Method

<a name="kanchor325"></a>ISYSDocument:Icon Method

Returns the path to an icon that can be used to represent this document. Read-Only.

Syntax

[VBScript]
function ISYSDocument.Icon(_
  string Destination, _ 
  ISYSIconFormat Format, _ 
  ISYSIconSize Dimensions, _ 
  string Background_ 
) as string

[C#]
string ISYSDocument.Icon(
  string Destination, 
  ISYSIconFormat Format, 
  ISYSIconSize Dimensions, 
  string Background
);

[ColdFusion/Java]
java.lang.String IISYSDocument.Icon(
  java.lang.String Destination, 
  ISYSIconFormat Format, 
  ISYSIconSize Dimensions, 
  java.lang.String Background
) throws ComException;

Parameters

Destination

The folder where the icon should be saved. For web servers, this should be a folder that can be served.

Format

[Optional] The file format that should be used for the icon.

isysIconGIF	0	GIF Format
isysIconBMP	1	Bitmap Format
isysIconICO	2	Windows Icon Format
isysIconJPG	3	JPeg Format

Dimensions

[Optional] The icons size

	isysIconSmall		0		The small icon size used by windows, generally 16x16.
	isysIconLarge		1		The small icon size used by windows, generally 32x32.

Background

[Optional] The background color to use when saving in formats that do not support transparency.

Examples

[VBScript]

<%
' Execute a pre-configured ISYSSearch object  
Set Results = ISYSSearch.Execute

' Get the document  
Set Document = Results(CLng("doc"))
ImagePath = Server.MapPath("/images/icon")
Icon = Document.Icon(ImagePath, isysIconGIF, isysIconSmall)
%>  

<img src="/images/icons/<%= Icon %>" />