DocumentBuilderInsertImage Method (Stream, RelativeHorizontalPosition, Double, RelativeVerticalPosition, Double, Double, Double, WrapType) |
Inserts an image from a stream at the specified position and size.
Namespace:
Aspose.Words
Assembly:
Aspose.Words (in Aspose.Words.dll) Version: 20.3
Syntaxpublic Shape InsertImage(
Stream stream,
RelativeHorizontalPosition horzPos,
double left,
RelativeVerticalPosition vertPos,
double top,
double width,
double height,
WrapType wrapType
)
Public Function InsertImage (
stream As Stream,
horzPos As RelativeHorizontalPosition,
left As Double,
vertPos As RelativeVerticalPosition,
top As Double,
width As Double,
height As Double,
wrapType As WrapType
) As Shape
public:
Shape^ InsertImage(
Stream^ stream,
RelativeHorizontalPosition horzPos,
double left,
RelativeVerticalPosition vertPos,
double top,
double width,
double height,
WrapType wrapType
)
member InsertImage :
stream : Stream *
horzPos : RelativeHorizontalPosition *
left : float *
vertPos : RelativeVerticalPosition *
top : float *
width : float *
height : float *
wrapType : WrapType -> Shape
Parameters
- stream
- Type: System.IOStream
The stream that contains the image. - horzPos
- Type: Aspose.Words.DrawingRelativeHorizontalPosition
Specifies where the distance to the image is measured from. - left
- Type: SystemDouble
Distance in points from the origin to the left side of the image. - vertPos
- Type: Aspose.Words.DrawingRelativeVerticalPosition
Specifies where the distance to the image measured from. - top
- Type: SystemDouble
Distance in points from the origin to the top side of the image. - width
- Type: SystemDouble
The width of the image in points. Can be a negative or zero value to request 100% scale. - height
- Type: SystemDouble
The height of the image in points. Can be a negative or zero value to request 100% scale. - wrapType
- Type: Aspose.Words.DrawingWrapType
Specifies how to wrap text around the image.
Return Value
Type:
ShapeThe image node that was just inserted.
RemarksYou can change the image size, location, positioning method and other settings using the
Shape object returned by this method.
ExamplesShows different solutions of how to import an image into a document from a stream.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
using (Stream stream = File.OpenRead(ImageDir + "Logo.jpg"))
{
builder.Writeln("Inserted image from stream: ");
builder.InsertImage(stream);
builder.Writeln("\nInserted image from stream with a custom size: ");
builder.InsertImage(stream, ConvertUtil.PixelToPoint(250), ConvertUtil.PixelToPoint(144));
builder.Writeln("\nInserted image from stream using relative positions: ");
builder.InsertImage(stream, RelativeHorizontalPosition.Margin, 100, RelativeVerticalPosition.Margin,
100, 200, 100, WrapType.Square);
}
doc.Save(ArtifactsDir + "DocumentBuilderImages.InsertImageFromStream.docx");
See Also