Windward Studios API Reference
SetImagePath Method
See Also  Send comments on this topic.
net.windward.api.csharp Namespace > ReportHtml Class : SetImagePath Method




path
The path of the file on the disk relative to the default directory of your program.
html
The path of the file relative to the default directory of the client browser.
prefix
The prefix to use when creating the filename. This can be null.

Glossary Item Box

Set a path that all images will be saved to. All images will be written to the disk as they are read from the template. If this is called, you may not also call addImageName. You can however after processing call getImageNames and the filenames will be in there (but not the streams). The path can be just a series of folders like "c:/dir1/dir2/" or it can include the begining of the filename like "c:/dir1/dir2/tmp". The first will create the file "c:/dir1/dir2/00001.jpg" while the second will create the file "c:/dir1/dir2/tmp00001.jpg". Note: file and prefix should not end with a / Note: as Windward Reports has no idea when the created file is no longer needed, it will not delete any files created. Note: The path seperator can be / or \.

Syntax

Visual Basic (Declaration) 
Public Sub SetImagePath( _
   ByVal path As String, _
   ByVal html As String, _
   ByVal prefix As String _
)
Visual Basic (Usage)Copy Code
Dim instance As ReportHtml
Dim path As String
Dim html As String
Dim prefix As String
 
instance.SetImagePath(path, html, prefix)
C# 
public void SetImagePath( 
   string path,
   string html,
   string prefix
)
Managed Extensions for C++ 
public: void SetImagePath( 
   string* path,
   string* html,
   string* prefix
)
C++/CLI 
public:
void SetImagePath( 
   String^ path,
   String^ html,
   String^ prefix
)

Parameters

path
The path of the file on the disk relative to the default directory of your program.
html
The path of the file relative to the default directory of the client browser.
prefix
The prefix to use when creating the filename. This can be null.

Requirements

Platforms: Windows 10, Windows NT, Windows Server

See Also

Windward Studios - .NET Document Generation software