CustomRenderSaveFileTypes.SaveFileHandler Delegate

CustomRenderSaveFileTypesSaveFileHandler Delegate

Called when a user chooses to save a rendered scene as this custom file type.

Namespace:  Rhino.PlugIns
Assembly:  RhinoCommon (in RhinoCommon.dll)
Syntax
Copy
public delegate bool SaveFileHandler(
	string fileName,
	bool includeAlpha,
	RenderWindow renderWindow
)
Public Delegate Function SaveFileHandler ( 
	fileName As String,
	includeAlpha As Boolean,
	renderWindow As RenderWindow
) As Boolean

Parameters

fileName
Type: SystemString
Name of the file to write.
includeAlpha
Type: SystemBoolean
Only meaningful if the custom file type optionally supports alpha channel.
renderWindow
Type: Rhino.RenderRenderWindow
The RenderWindow to save.

Return Value

Type: Boolean
Return true if the file was written successfully otherwise return false.
Version Information

Rhino for Windows

Supported in: 6.8
See Also

T:Rhino.PlugIns.CustomRenderSaveFileTypes.SaveFileHandler